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

Detailed Description

Policy attributes used in batch UDF apply commands.

Definition at line 1037 of file as_policy.h.

#include "as_policy.h"

+ Collaboration diagram for as_policy_batch_apply:

Data Fields

as_policy_commit_level commit_level
 
bool durable_delete
 
struct as_expfilter_exp
 
as_policy_key key
 
uint32_t ttl
 

Related Functions

(Note that these are not member functions.)

static as_policy_batch_applyas_policy_batch_apply_init (as_policy_batch_apply *p)
 

Friends And Related Function Documentation

static as_policy_batch_apply * as_policy_batch_apply_init ( as_policy_batch_apply p)
related

Initialize as_policy_batch_apply to default values.

Definition at line 1696 of file as_policy.h.

References AS_POLICY_COMMIT_LEVEL_DEFAULT, AS_POLICY_KEY_DEFAULT, commit_level, durable_delete, filter_exp, key, and ttl.

Field Documentation

as_policy_commit_level as_policy_batch_apply::commit_level

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

Definition at line 1060 of file as_policy.h.

bool as_policy_batch_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 1082 of file as_policy.h.

struct as_exp* as_policy_batch_apply::filter_exp

Optional expression filter. If filter_exp exists and evaluates to false, the transaction is ignored. This can be used to eliminate a client/server roundtrip in some cases.

aerospike_destroy() automatically calls as_exp_destroy() on all global default policy filter expression instances. The user is responsible for calling as_exp_destroy() on filter expressions when setting temporary transaction policies.

Default: NULL

Definition at line 1049 of file as_policy.h.

as_policy_key as_policy_batch_apply::key

Specifies the behavior for the key.

Definition at line 1054 of file as_policy.h.

uint32_t as_policy_batch_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 1073 of file as_policy.h.


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