WritePolicy FieldsAerospike
The WritePolicy type exposes the following members.
Fields

  NameDescription
Public fieldcommitLevel
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.
Public fieldconsistencyLevel
How replicas should be consulted in a read operation to provide the desired consistency guarantee. Default to allowing one replica to be used in the read operation.
(Inherited from Policy.)
Public fieldexpiration
Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server.

Expiration values:

  • -1: Never expire. Supported by Aerospike 2 server versions >= 2.7.2 and Aerospike 3 server versions >= 3.1.4.
  • 0: Default to namespace's "default-ttl" on the server.
  • > 0: Actual expiration in seconds.

Public fieldgeneration
Expected generation. Generation is the number of times a record has been modified (including creation) on the server. If a write operation is creating a record, the expected generation would be 0.
Public fieldgenerationPolicy
Qualify how to handle record writes based on record generation. The default (NONE) indicates that the generation is not used to restrict writes.
Public fieldmaxRetries
Maximum number of retries before aborting the current transaction. A retry is attempted when there is a network error other than timeout. If maxRetries is exceeded, the abort will occur even if the timeout has not yet been exceeded. The default number of retries is 1.
(Inherited from Policy.)
Public fieldpriority
Priority of request relative to other transactions. Currently, only used for scans.
(Inherited from Policy.)
Public fieldrecordExistsAction
Qualify how to handle writes where the record already exists.
Public fieldreplica
Send read commands to the node containing the key's partition replica type. Write commands are not affected by this setting, because all writes are directed to the node containing the key's master partition.

Default to sending read commands to the node containing the key's master partition.

(Inherited from Policy.)
Public fieldsendKey
Send user defined key in addition to hash digest on both reads and writes. The default is to not send the user defined key.
(Inherited from Policy.)
Public fieldsleepBetweenRetries
Milliseconds to sleep between retries if a transaction fails and the timeout was not exceeded. The default sleep between retries is 500 ms.
(Inherited from Policy.)
Public fieldtimeout
Total transaction timeout in milliseconds for both client and server. The timeout is tracked on the client and also sent to the server along with the transaction in the wire protocol. The client will most likely timeout first, but the server has the capability to timeout the transaction as well.

The timeout is also used as a socket timeout. Retries will not occur if the timeout limit has been reached. Default to no timeout (0).

(Inherited from Policy.)
Back to Top
See Also