Detailed Description

Write Policy

Definition at line 561 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

as_policy_replica	replica

uint32_t	ttl

Related Functions
(Note that these are not member functions.)
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 Function Documentation

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

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 1470 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, replica, and ttl.

Field Documentation

as_policy_base as_policy_write::base

Generic policy fields.

Definition at line 566 of file as_policy.h.

as_policy_commit_level as_policy_write::commit_level

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

Definition at line 582 of file as_policy.h.

uint32_t as_policy_write::compression_threshold

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

Definition at line 611 of file as_policy.h.

bool as_policy_write::durable_delete

If the transaction 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 620 of file as_policy.h.

as_policy_exists as_policy_write::exists

Specifies the behavior for the existence of the record.

Definition at line 592 of file as_policy.h.

as_policy_gen as_policy_write::gen

Specifies the behavior for the generation value.

Definition at line 587 of file as_policy.h.

as_policy_key as_policy_write::key

Specifies the behavior for the key.

Definition at line 571 of file as_policy.h.

as_policy_replica as_policy_write::replica

Algorithm used to determine target node.

Definition at line 576 of file as_policy.h.

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

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

as_policy.h

Detailed Description

Data Fields

Related Functions

Friends And Related Function Documentation

Field Documentation