All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Data Fields | Related Functions
as_policy_apply Struct Reference

Detailed Description

Key Apply Policy

Definition at line 498 of file as_policy.h.

#include "as_policy.h"

+ Collaboration diagram for as_policy_apply:

Data Fields

as_policy_commit_level commit_level
 
bool durable_delete
 
as_policy_key key
 
uint32_t retry
 
bool retry_on_timeout
 
uint32_t sleep_between_retries
 
uint32_t timeout
 
uint32_t ttl
 

Related Functions

(Note that these are not member functions.)

static void as_policy_apply_copy (as_policy_apply *src, as_policy_apply *trg)
 
static as_policy_applyas_policy_apply_init (as_policy_apply *p)
 

Friends And Related Function Documentation

static void as_policy_apply_copy ( as_policy_apply src,
as_policy_apply trg 
)
related

Copy as_policy_apply values.

Parameters
srcThe source policy.
trgThe target policy.

Definition at line 1275 of file as_policy.h.

static as_policy_apply * as_policy_apply_init ( as_policy_apply p)
related

Initialize as_policy_apply to default values.

Parameters
pThe policy to initialize.
Returns
The initialized policy.

Definition at line 1253 of file as_policy.h.

References AS_POLICY_COMMIT_LEVEL_DEFAULT, AS_POLICY_KEY_DEFAULT, AS_POLICY_RETRY_DEFAULT, AS_POLICY_RETRY_SLEEP_DEFAULT, AS_POLICY_TIMEOUT_DEFAULT, commit_level, durable_delete, key, retry, retry_on_timeout, sleep_between_retries, timeout, and ttl.

Field Documentation

as_policy_commit_level as_policy_apply::commit_level

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

Definition at line 529 of file as_policy.h.

bool as_policy_apply::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 573 of file as_policy.h.

as_policy_key as_policy_apply::key

Specifies the behavior for the key.

Definition at line 522 of file as_policy.h.

uint32_t as_policy_apply::retry

Maximum number of retries when a transaction fails due to a network error. Used by synchronous commands only. Default: 1

Definition at line 510 of file as_policy.h.

bool as_policy_apply::retry_on_timeout

Should the client retry a command if the timeout is reached. Used by synchronous commands only.

Values:

  • false: Return error when the timeout has been reached. Note that retries can still occur if a command fails on a network error before the timeout has been reached.
  • true: Retry command with same timeout when the timeout has been reached. The maximum number of retries is defined by retry.

Default: false

Definition at line 564 of file as_policy.h.

uint32_t as_policy_apply::sleep_between_retries

Milliseconds to sleep between retries. Used by synchronous commands only. Default: 0 (do not sleep)

Definition at line 517 of file as_policy.h.

uint32_t as_policy_apply::timeout

Maximum time in milliseconds to wait for the operation to complete.

Definition at line 503 of file as_policy.h.

uint32_t as_policy_apply::ttl

The time-to-live (expiration) of the record in seconds. There are also special values that can be set in the record TTL: (*) ZERO (defined as AS_RECORD_DEFAULT_TTL), which means that the record will adopt the default TTL value from the namespace. (*) 0xFFFFFFFF (also, -1 in a signed 32 bit int) (defined as AS_RECORD_NO_EXPIRE_TTL), which means that the record will get an internal "void_time" of zero, and thus will never expire. (*) 0xFFFFFFFE (also, -2 in a signed 32 bit int) (defined as AS_RECORD_NO_CHANGE_TTL), which means that the record ttl will not change when the record is updated.

Note that the TTL value will be employed ONLY on write/update calls.

Definition at line 545 of file as_policy.h.


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