com.aerospike.client.policy

Class BatchDeletePolicy

java.lang.Object

com.aerospike.client.policy.BatchDeletePolicy

public final class BatchDeletePolicy
extends Object

Policy attributes used in batch delete commands.

Field Summary

Fields

Modifier and Type	Field and Description
CommitLevel	commitLevel Desired consistency guarantee when committing a transaction on the server.
boolean	durableDelete If the transaction results in a record deletion, leave a tombstone for the record.
Expression	filterExp Optional expression filter.
int	generation Expected generation.
GenerationPolicy	generationPolicy Qualify how to handle record deletes based on record generation.
boolean	sendKey Send user defined key in addition to hash digest.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	setCommitLevel(CommitLevel commitLevel)
void	setDurableDelete(boolean durableDelete)
void	setFilterExp(Expression filterExp)
void	setGeneration(int generation)
void	setGenerationPolicy(GenerationPolicy generationPolicy)
void	setSendKey(boolean sendKey)

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

commitLevel

public CommitLevel commitLevel

Desired consistency guarantee when committing a transaction on the server. The default (COMMIT_ALL) indicates that the server should wait for master and all replica commits to be successful before returning success to the client.

Default: CommitLevel.COMMIT_ALL

generationPolicy

public GenerationPolicy generationPolicy

Qualify how to handle record deletes based on record generation. The default (NONE) indicates that the generation is not used to restrict deletes.

Default: GenerationPolicy.NONE

generation

public int generation

Expected generation. Generation is the number of times a record has been modified (including creation) on the server. This field is only relevant when generationPolicy is not NONE.

Default: 0

durableDelete

public boolean durableDelete

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).

sendKey

public boolean sendKey

Send user defined key in addition to hash digest. If true, the key will be stored with the tombstone record on the server.

Default: false (do not send the user defined key)

Constructor Detail

BatchDeletePolicy

public BatchDeletePolicy(BatchDeletePolicy other)

Copy constructor.

BatchDeletePolicy

public BatchDeletePolicy()

Default constructor.

Method Detail

setFilterExp

public void setFilterExp(Expression filterExp)

setCommitLevel

public void setCommitLevel(CommitLevel commitLevel)

setGenerationPolicy

public void setGenerationPolicy(GenerationPolicy generationPolicy)

setGeneration

public void setGeneration(int generation)

setDurableDelete

public void setDurableDelete(boolean durableDelete)

setSendKey

public void setSendKey(boolean sendKey)