Detailed Description

Write Policy

Definition at line 636 of file as_policy.h.

#include "as_policy.h"

Collaboration diagram for as_policy_write:

Data Fields
as_policy_base	base

as_policy_commit_level	commit_level

uint32_t	compression_threshold

bool	durable_delete

as_policy_exists	exists

as_policy_gen	gen

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_write_copy (const as_policy_write src, as_policy_write trg)

static as_policy_write *	as_policy_write_init (as_policy_write *p)

Friends And Related Symbol Documentation

◆ as_policy_write_copy()

static void as_policy_write_copy	(	const as_policy_write *	src,
		as_policy_write *	trg )

Parameters

src	The source policy.
trg	The target policy.

Definition at line 1749 of file as_policy.h.

◆ as_policy_write_init()

static as_policy_write * as_policy_write_init ( as_policy_write * p )

Parameters

p	The policy to initialize.

Returns: The initialized policy.

Definition at line 1725 of file as_policy.h.

References as_policy_base_write_init(), AS_POLICY_COMMIT_LEVEL_DEFAULT, AS_POLICY_COMPRESSION_THRESHOLD_DEFAULT, AS_POLICY_EXISTS_DEFAULT, AS_POLICY_GEN_DEFAULT, AS_POLICY_KEY_DEFAULT, AS_POLICY_REPLICA_DEFAULT, base, commit_level, compression_threshold, durable_delete, exists, gen, key, on_locking_only, replica, and ttl.

Field Documentation

◆ base

as_policy_base as_policy_write::base

Generic policy fields.

Definition at line 641 of file as_policy.h.

◆ commit_level

as_policy_commit_level as_policy_write::commit_level

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

Definition at line 657 of file as_policy.h.

◆ compression_threshold

uint32_t as_policy_write::compression_threshold

Minimum record size beyond which it is compressed and sent to the server.

Definition at line 686 of file as_policy.h.

◆ durable_delete

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

◆ exists

as_policy_exists as_policy_write::exists

Specifies the behavior for the existence of the record.

Definition at line 667 of file as_policy.h.

◆ gen

as_policy_gen as_policy_write::gen

Specifies the behavior for the generation value.

Definition at line 662 of file as_policy.h.

◆ key

as_policy_key as_policy_write::key

Specifies the behavior for the key.

Definition at line 646 of file as_policy.h.

◆ on_locking_only

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

◆ replica

as_policy_replica as_policy_write::replica

Algorithm used to determine target node.

Definition at line 651 of file as_policy.h.

◆ ttl

uint32_t as_policy_write::ttl

The default time-to-live (expiration) of the record in seconds. This field will only be used if "as_record.ttl" is set to AS_RECORD_CLIENT_DEFAULT_TTL. The as_record instance is passed in to write functions along with as_policy_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 681 of file as_policy.h.

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

as_policy.h