OptionalcommitSpecifies the number of replicas required to be committed successfully when writing before returning command succeeded.
policy.commitLevel for supported policy values.
OptionalcompressUse zlib compression on write or batch read commands when the command buffer size is greater than 128 bytes. In addition, tell the server to compress it's response on read commands. The server response compression threshold is also 128 bytes.
This option will increase cpu and memory usage (for extra compressed buffers), but decrease the size of data sent over the network.
Requires Enterprise Server version >= 4.8.
@default: false
OptionaldeserializeShould CDT data types (Lists / Maps) be deserialized to JS data types (Arrays / Objects) or returned as raw bytes (Buffer).
OptionaldurableSpecifies whether a http://www.aerospike.com/docs/guide/durable_deletes.html|tombstone should be written in place of a record that gets deleted as a result of this command.
OptionalexistsSpecifies the behavior for the existence of the record.
policy.exists for supported policy values.
OptionalfilterOptional expression filter. If filter exp exists and evaluates to false, the command is ignored. This can be used to eliminate a client/server roundtrip in some cases.
expression filters can only be applied to the following commands:
OptionalgenSpecifies the behavior for the generation value.
policy.gen for supported policy values.
OptionalkeySpecifies the behavior for the key.
policy.key for supported policy values.
OptionalmaxMaximum number of retries before aborting the current command. The initial attempt is not counted as a retry.
If maxRetries is exceeded, the command will return
error ERR_TIMEOUT.
WARNING: Database writes that are not idempotent (such as "add")
should not be retried because the write command may be performed
multiple times if the client timed out previous command attempts.
It is important to use a distinct write policy for non-idempotent
writes which sets maxRetries to zero.
@default: 2 (initial attempt + 2 retries = 3 attempts)
OptionalreadRead policy for AP (availability) namespaces.
policy.readModeAP for supported policy values.
OptionalreadRead policy for SC (strong consistency) namespaces.
policy.readModeSC for supported policy values.
OptionalreadDetermine 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.
OptionalreplicaSpecifies the replica to be consulted for the read command.
policy.replica for supported policy values.
OptionalsocketSocket idle timeout in milliseconds when processing a database command.
If socketTimeout is not zero and the socket has been idle
for at least socketTimeout, both maxRetries
and totalTimeout are checked. If maxRetries
and totalTimeout are not exceeded, the command is
retried.
If both socketTimeout and totalTimeout are
non-zero and socketTimeout > totalTimeout,
then socketTimeout will be set to
totalTimeout. If socketTimeout is zero, there
will be no socket idle limit.
OptionaltotalTotal command timeout in milliseconds.
The totalTimeout is tracked on the client and sent to the
server along with the command in the wire protocol. The client will
most likely timeout first, but the server also has the capability to
timeout the command
If totalTimeout is not zero and totalTimeout
is reached before the command completes, the command will return
error ERR_TIMEOUT.
If totalTimeout is zero, there will be no total time limit.
OptionaltxnTransaction identifier. See Transaction for more information.
Option specification for {@ link AdminPolicy} class values.