Detailed Description

Policy attributes used in batch UDF apply commands.

Definition at line 1237 of file as_policy.h.

#include "as_policy.h"

Collaboration diagram for as_policy_batch_apply:

Data Fields
as_policy_commit_level	commit_level

bool	durable_delete

struct as_exp *	filter_exp

as_policy_key	key

bool	on_locking_only

uint32_t	ttl

Related Symbols
(Note that these are not member symbols.)
static as_policy_batch_apply *	as_policy_batch_apply_init (as_policy_batch_apply *p)

Friends And Related Symbol Documentation

◆ as_policy_batch_apply_init()

static as_policy_batch_apply * as_policy_batch_apply_init ( as_policy_batch_apply * p )

Definition at line 1959 of file as_policy.h.

References AS_POLICY_COMMIT_LEVEL_DEFAULT, AS_POLICY_KEY_DEFAULT, commit_level, durable_delete, filter_exp, key, on_locking_only, and ttl.

Field Documentation

◆ commit_level

as_policy_commit_level as_policy_batch_apply::commit_level

Specifies the number of replicas required to be committed successfully when writing before returning command succeeded.

Definition at line 1260 of file as_policy.h.

◆ durable_delete

bool as_policy_batch_apply::durable_delete

If the command results in a record deletion, leave a tombstone for the record. This prevents deleted records from reappearing after node failures. Valid for Aerospike Server Enterprise Edition only.

Default: false (do not tombstone deleted records).

Definition at line 1282 of file as_policy.h.

◆ filter_exp

struct as_exp* as_policy_batch_apply::filter_exp

Optional expression filter. If filter_exp exists and evaluates to false, the command is ignored. This can be used to eliminate a client/server roundtrip in some cases.

aerospike_destroy() automatically calls as_exp_destroy() on all global default policy filter expression instances. The user is responsible for calling as_exp_destroy() on filter expressions when setting temporary command policies.

Default: NULL

Definition at line 1249 of file as_policy.h.

◆ key

as_policy_key as_policy_batch_apply::key

Specifies the behavior for the key.

Definition at line 1254 of file as_policy.h.

◆ on_locking_only

bool as_policy_batch_apply::on_locking_only

Execute the write command only if the record is not already locked by this transaction. If this field is true and the record is already locked by this transaction, the command will return AEROSPIKE_MRT_ALREADY_LOCKED.

This field is useful for safely retrying non-idempotent writes as an alternative to simply aborting the transaction.

Default: false.

Definition at line 1294 of file as_policy.h.

◆ ttl

uint32_t as_policy_batch_apply::ttl

The time-to-live (expiration) of the record in seconds. Note that ttl is only used on write/update calls.

There are also special values that can be set in the record ttl:

AS_RECORD_DEFAULT_TTL: Use the server default ttl from the namespace.
AS_RECORD_NO_EXPIRE_TTL: Do not expire the record.
AS_RECORD_NO_CHANGE_TTL: Keep the existing record ttl when the record is updated.

Definition at line 1273 of file as_policy.h.

The documentation for this struct was generated from the following file:

as_policy.h