Detailed Description

Key Apply Policy

Definition at line 716 of file as_policy.h.

#include "as_policy.h"

Collaboration diagram for as_policy_apply:

Data Fields
as_policy_base	base

as_policy_commit_level	commit_level

bool	durable_delete

as_policy_key	key

bool	on_locking_only

as_policy_replica	replica

uint32_t	ttl

Related Symbols
(Note that these are not member symbols.)
static void	as_policy_apply_copy (const as_policy_apply src, as_policy_apply trg)

static as_policy_apply *	as_policy_apply_init (as_policy_apply *p)

Friends And Related Symbol Documentation

◆ as_policy_apply_copy()

static void as_policy_apply_copy	(	const as_policy_apply *	src,
		as_policy_apply *	trg )

Parameters

src	The source policy.
trg	The target policy.

Definition at line 1862 of file as_policy.h.

◆ as_policy_apply_init()

static as_policy_apply * as_policy_apply_init ( as_policy_apply * p )

Parameters

p	The policy to initialize.

Returns: The initialized policy.

Definition at line 1841 of file as_policy.h.

References as_policy_base_write_init(), AS_POLICY_COMMIT_LEVEL_DEFAULT, AS_POLICY_KEY_DEFAULT, AS_POLICY_REPLICA_DEFAULT, base, commit_level, durable_delete, key, on_locking_only, replica, and ttl.

Field Documentation

◆ base

as_policy_base as_policy_apply::base

Generic policy fields.

Definition at line 721 of file as_policy.h.

◆ commit_level

as_policy_commit_level as_policy_apply::commit_level

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

Definition at line 737 of file as_policy.h.

◆ durable_delete

bool as_policy_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 759 of file as_policy.h.

◆ key

as_policy_key as_policy_apply::key

Specifies the behavior for the key.

Definition at line 726 of file as_policy.h.

◆ on_locking_only

bool as_policy_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 771 of file as_policy.h.

◆ replica

as_policy_replica as_policy_apply::replica

Algorithm used to determine target node.

Definition at line 731 of file as_policy.h.

◆ ttl

uint32_t as_policy_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 750 of file as_policy.h.

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

as_policy.h