No Matches
Data Fields | Related Symbols
as_policy_operate Struct Reference

Detailed Description

Operate Policy

Definition at line 745 of file as_policy.h.

#include "as_policy.h"

+ Collaboration diagram for as_policy_operate:

Data Fields

bool async_heap_rec
as_policy_base base
as_policy_commit_level commit_level
bool deserialize
bool durable_delete
as_policy_exists exists
as_policy_gen gen
as_policy_key key
as_policy_read_mode_ap read_mode_ap
as_policy_read_mode_sc read_mode_sc
int read_touch_ttl_percent
as_policy_replica replica
uint32_t ttl

Related Symbols

(Note that these are not member symbols.)

static void as_policy_operate_copy (const as_policy_operate *src, as_policy_operate *trg)
static as_policy_operateas_policy_operate_init (as_policy_operate *p)

Friends And Related Symbol Documentation

◆ as_policy_operate_copy()

static void as_policy_operate_copy ( const as_policy_operate * src,
as_policy_operate * trg )

Shallow copy as_policy_operate values.

srcThe source policy.
trgThe target policy.

Definition at line 1679 of file as_policy.h.

◆ as_policy_operate_init()

static as_policy_operate * as_policy_operate_init ( as_policy_operate * p)

Field Documentation

◆ async_heap_rec

bool as_policy_operate::async_heap_rec

Should as_record instance be allocated on the heap before user listener is called in async commands. If true, the user is responsible for calling as_record_destroy() when done with the record. If false, as_record_destroy() is automatically called by the client after the user listener function completes. This field is ignored for sync commands.

Default: false

Definition at line 851 of file as_policy.h.

◆ base

as_policy_base as_policy_operate::base

Generic policy fields.

Definition at line 750 of file as_policy.h.

◆ commit_level

as_policy_commit_level as_policy_operate::commit_level

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

Definition at line 778 of file as_policy.h.

◆ deserialize

bool as_policy_operate::deserialize

Should raw bytes representing a list or map be deserialized to as_list or as_map. Set to false for backup programs that just need access to raw bytes.

Default: true

Definition at line 832 of file as_policy.h.

◆ durable_delete

bool as_policy_operate::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 841 of file as_policy.h.

◆ exists

as_policy_exists as_policy_operate::exists

Specifies the behavior for the existence of the record.

Definition at line 788 of file as_policy.h.

◆ gen

as_policy_gen as_policy_operate::gen

Specifies the behavior for the generation value.

Definition at line 783 of file as_policy.h.

◆ key

as_policy_key as_policy_operate::key

Specifies the behavior for the key.

Definition at line 755 of file as_policy.h.

◆ read_mode_ap

as_policy_read_mode_ap as_policy_operate::read_mode_ap

Read policy for AP (availability) namespaces. Default: AS_POLICY_READ_MODE_AP_ONE

Definition at line 766 of file as_policy.h.

◆ read_mode_sc

as_policy_read_mode_sc as_policy_operate::read_mode_sc

Read policy for SC (strong consistency) namespaces. Default: AS_POLICY_READ_MODE_SC_SESSION

Definition at line 772 of file as_policy.h.

◆ read_touch_ttl_percent

int as_policy_operate::read_touch_ttl_percent

Determine how record TTL (time to live) is affected on reads. When enabled, the server can efficiently operate as a read-based LRU cache where the least recently used records are expired. The value is expressed as a percentage of the TTL sent on the most recent write such that a read within this interval of the record’s end of life will generate a touch.

For example, if the most recent write had a TTL of 10 hours and read_touch_ttl_percent is set to 80, the next read within 8 hours of the record's end of life (equivalent to 2 hours after the most recent write) will result in a touch, resetting the TTL to another 10 hours.


  • 0 : Use server config default-read-touch-ttl-pct for the record's namespace/set.
  • -1 : Do not reset record TTL on reads.
  • 1 - 100 : Reset record TTL on reads when within this percentage of the most recent write TTL.

Default: 0

Definition at line 824 of file as_policy.h.

◆ replica

as_policy_replica as_policy_operate::replica

Algorithm used to determine target node.

Definition at line 760 of file as_policy.h.

◆ ttl

uint32_t as_policy_operate::ttl

The default time-to-live (expiration) of the record in seconds. This field will only be used if one or more of the operations is a write operation and if "as_operations.ttl" is set to AS_RECORD_CLIENT_DEFAULT_TTL. The as_operations instance is passed in to operate functions along with as_policy_operate.

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

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