BatchWritePolicy Class

Policy attributes used in batch write commands.

Definition

Namespace: Aerospike.Client
Assembly: AerospikeClient (in AerospikeClient.dll) Version: 8.0.1+e35566e493546c0887ebb841c8e2a2c6a7cbde18
C#
public sealed class BatchWritePolicy
Inheritance
Object    BatchWritePolicy

Constructors

BatchWritePolicy() Default constructor.
BatchWritePolicy(BatchWritePolicy) Copy constructor.

Methods

Clone Creates a deep copy of this batch write policy.

Fields

commitLevel Desired consistency guarantee when committing a command 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

durableDelete If the command 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).

expiration Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server.

Expiration values:

  • -2: Do not change ttl when record is updated.
  • -1: Never expire.
  • 0: Default to namespace configuration variable "default-ttl" on the server.
  • > 0: Actual ttl in seconds.

Default: 0

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

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

Default: null

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

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

OnLockingOnly Execute the write command only if the record is not already locked by this transaction. If this field is true and the record is already locked by this transaction, the command will throw an exception with the MRT_ALREADY_LOCKED error code.

This field is useful for safely retrying non-idempotent writes as an alternative to simply aborting the transaction. This field is not applicable to record delete commands.

Default: false.

recordExistsAction Qualify how to handle writes where the record already exists.

Default: RecordExistsAction.UPDATE

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

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

See Also