com.aerospike.client.policy

Class BatchReadPolicy

java.lang.Object

com.aerospike.client.policy.BatchReadPolicy

public final class BatchReadPolicy
extends Object

Policy attributes used in batch read commands.

Field Summary

Fields

Modifier and Type	Field and Description
Expression	filterExp Optional expression filter.
ReadModeAP	readModeAP Read policy for AP (availability) namespaces.
ReadModeSC	readModeSC Read policy for SC (strong consistency) namespaces.
int	readTouchTtlPercent Determine how record TTL (time to live) is affected on reads.

Constructor Summary

Constructors

Constructor and Description
BatchReadPolicy() Default constructor.
BatchReadPolicy(BatchReadPolicy other) Copy constructor.

Method Summary

Modifier and Type	Method and Description
void	setFilterExp(Expression filterExp)
void	setReadModeAP(ReadModeAP readModeAP)
void	setReadModeSC(ReadModeSC readModeSC)
void	setReadTouchTtlPercent(int readTouchTtlPercent)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

filterExp

public Expression filterExp

Optional expression filter. If filterExp exists and evaluates to false, the specific batch key request is not performed and BatchRecord.resultCode is set to ResultCode.FILTERED_OUT.

If exists, this filter overrides the batch parent filter Policy.filterExp for the specific key in batch commands that allow a different policy per key. Otherwise, this filter is ignored.

Default: null

readModeAP

public ReadModeAP readModeAP

Read policy for AP (availability) namespaces.

Default: ReadModeAP.ONE

readModeSC

public ReadModeSC readModeSC

Read policy for SC (strong consistency) namespaces.

Default: ReadModeSC.SESSION

readTouchTtlPercent

public int readTouchTtlPercent

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.

Values:

• 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

Constructor Detail

BatchReadPolicy

public BatchReadPolicy(BatchReadPolicy other)

Copy constructor.

BatchReadPolicy

public BatchReadPolicy()

Default constructor.

Method Detail

setFilterExp

public void setFilterExp(Expression filterExp)

setReadModeAP

public void setReadModeAP(ReadModeAP readModeAP)

setReadModeSC

public void setReadModeSC(ReadModeSC readModeSC)

setReadTouchTtlPercent

public void setReadTouchTtlPercent(int readTouchTtlPercent)