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 629 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
 
as_policy_replica replica
 
uint32_t ttl
 

Related Functions

(Note that these are not member functions.)

static void as_policy_apply_copy (const 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 ( const as_policy_apply src,
as_policy_apply trg 
)
related

Shallow copy as_policy_apply values.

Parameters
srcThe source policy.
trgThe target policy.

Definition at line 1602 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 1582 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, replica, and ttl.

Field Documentation

as_policy_base as_policy_apply::base

Generic policy fields.

Definition at line 634 of file as_policy.h.

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

as_policy_key as_policy_apply::key

Specifies the behavior for the key.

Definition at line 639 of file as_policy.h.

as_policy_replica as_policy_apply::replica

Algorithm used to determine target node.

Definition at line 644 of file as_policy.h.

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


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