Detailed Description

Policy attributes used in batch write commands.

Definition at line 1161 of file as_policy.h.

#include "as_policy.h"

Collaboration diagram for as_policy_batch_write:

Data Fields
as_policy_commit_level	commit_level

bool	durable_delete

as_policy_exists	exists

struct as_exp *	filter_exp

as_policy_gen	gen

as_policy_key	key

bool	on_locking_only

uint32_t	ttl

Related Symbols
(Note that these are not member symbols.)
static as_policy_batch_write *	as_policy_batch_write_init (as_policy_batch_write *p)

Friends And Related Symbol Documentation

◆ as_policy_batch_write_init()

static as_policy_batch_write * as_policy_batch_write_init ( as_policy_batch_write * p )

Definition at line 1941 of file as_policy.h.

References AS_POLICY_COMMIT_LEVEL_DEFAULT, AS_POLICY_EXISTS_DEFAULT, AS_POLICY_GEN_DEFAULT, AS_POLICY_KEY_DEFAULT, commit_level, durable_delete, exists, filter_exp, gen, key, on_locking_only, and ttl.

Field Documentation

◆ commit_level

as_policy_commit_level as_policy_batch_write::commit_level

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

Definition at line 1184 of file as_policy.h.

◆ durable_delete

bool as_policy_batch_write::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 1217 of file as_policy.h.

◆ exists

as_policy_exists as_policy_batch_write::exists

Specifies the behavior for the existence of the record.

Definition at line 1194 of file as_policy.h.

◆ filter_exp

struct as_exp* as_policy_batch_write::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 1173 of file as_policy.h.

◆ gen

as_policy_gen as_policy_batch_write::gen

Specifies the behavior for the generation value.

Definition at line 1189 of file as_policy.h.

◆ key

as_policy_key as_policy_batch_write::key

Specifies the behavior for the key.

Definition at line 1178 of file as_policy.h.

◆ on_locking_only

bool as_policy_batch_write::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 1229 of file as_policy.h.

◆ ttl

uint32_t as_policy_batch_write::ttl

The default time-to-live (expiration) of the record in seconds. This field will only be used if "as_operations.ttl" is set to AS_RECORD_CLIENT_DEFAULT_TTL. The as_operations instance is passed in to batch write functions along with as_policy_batch_write.

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 1208 of file as_policy.h.

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

as_policy.h