No Matches
Data Fields | Related Symbols
as_policy_batch_read Struct Reference

Detailed Description

Policy attributes used in batch read commands.

Definition at line 1048 of file as_policy.h.

#include "as_policy.h"

+ Collaboration diagram for as_policy_batch_read:

Data Fields

struct as_expfilter_exp
as_policy_read_mode_ap read_mode_ap
as_policy_read_mode_sc read_mode_sc
int read_touch_ttl_percent

Related Symbols

(Note that these are not member symbols.)

static as_policy_batch_readas_policy_batch_read_init (as_policy_batch_read *p)

Friends And Related Symbol Documentation

◆ as_policy_batch_read_init()

static as_policy_batch_read * as_policy_batch_read_init ( as_policy_batch_read * p)

Field Documentation

◆ filter_exp

struct as_exp* as_policy_batch_read::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 1060 of file as_policy.h.

◆ read_mode_ap

as_policy_read_mode_ap as_policy_batch_read::read_mode_ap

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

Definition at line 1066 of file as_policy.h.

◆ read_mode_sc

as_policy_read_mode_sc as_policy_batch_read::read_mode_sc

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

Definition at line 1072 of file as_policy.h.

◆ read_touch_ttl_percent

int as_policy_batch_read::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 1093 of file as_policy.h.

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