Optional
compressUse 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
Optional
durableSpecifies 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.
Optional
filterOptional 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:
Optional
maxApproximate number of records to return to client. This number is divided by the number of nodes involved in the scan. The actual number of records returned may be less than maxRecords if node record counts are small and unbalanced across nodes.
Requires server >= 4.9.
Optional
maxMaximum 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)
Optional
recordsLimit returned records per second (RPS) rate for each server. Do not
apply RPS limit if recordsPerSecond
is zero.
Requires server >= 4.7.
Optional
replicaSpecifies the replica to be consulted for the scan command.
policy.replica for supported policy values.
Optional
socketSocket 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.
Optional
totalTotal 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.
Optional
txnTransaction identifier. See Transaction for more information.
Option specification for {@ link AdminPolicy} class values.