com.aerospike.client.policy

Class WritePolicy

java.lang.Object

com.aerospike.client.policy.Policy

com.aerospike.client.policy.WritePolicy

public final class WritePolicy
extends Policy

Container object for policy attributes used in write operations. This object is passed into methods where database writes can occur.

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.
int	expiration Record expiration.
int	generation Expected generation.
GenerationPolicy	generationPolicy Qualify how to handle record writes based on record generation.
RecordExistsAction	recordExistsAction Qualify how to handle writes where the record already exists.
boolean	respondAllOps For client operate(), return a result for every operation.
boolean	xdr Operate in XDR mode.

Fields inherited from class com.aerospike.client.policy.Policy

compress, connectTimeout, failOnFilteredOut, filterExp, maxRetries, predExp, readModeAP, readModeSC, replica, sendKey, sleepBetweenRetries, socketTimeout, timeoutDelay, totalTimeout

Constructor Summary

Constructors

Constructor and Description
WritePolicy() Default constructor.
WritePolicy(Policy other) Copy write policy from another policy.
WritePolicy(WritePolicy other) Copy write policy from another write policy.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	hashCode()

Methods inherited from class com.aerospike.client.policy.Policy

setPredExp, setTimeout, setTimeouts

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

recordExistsAction

public RecordExistsAction recordExistsAction

Qualify how to handle writes where the record already exists.

Default: RecordExistsAction.UPDATE

generationPolicy

public GenerationPolicy generationPolicy

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

The server does not support this field for UDF execute() calls. The read-modify-write usage model can still be enforced inside the UDF code itself.

Default: GenerationPolicy.NONE

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

generation

public int generation

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. This field is only relevant when generationPolicy is not NONE.

The server does not support this field for UDF execute() calls. The read-modify-write usage model can still be enforced inside the UDF code itself.

Default: 0

expiration

public int 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

respondAllOps

public boolean respondAllOps

For client operate(), return a result for every operation.

Some operations do not return results by default (ListOperation.clear() for example). This can make it difficult to determine the desired result offset in the returned bin's result list.

Setting respondAllOps to true makes it easier to identify the desired result offset (result offset equals bin's operate sequence). If there is a map operation in operate(), respondAllOps will be forced to true for that operate() call.

Default: false

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 3.10+ only.

Default: false (do not tombstone deleted records).

xdr

public boolean xdr

Operate in XDR mode. Some external connectors may need to emulate an XDR client. If enabled, an XDR bit is set for writes in the wire protocol.

Default: false.

Constructor Detail

WritePolicy

public WritePolicy(WritePolicy other)

Copy write policy from another write policy.

WritePolicy

public WritePolicy(Policy other)

Copy write policy from another policy.

WritePolicy

public WritePolicy()

Default constructor.

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class Policy

equals

public boolean equals(Object obj)

Overrides:

equals in class Policy