Name | Description | |
---|---|---|
![]() | allowInline |
Allow batch to be processed immediately in the server's receiving thread when the server
deems it to be appropriate. If false, the batch will always be processed in separate
transaction threads. This field is only relevant for the new batch index protocol.
For batch exists or batch reads of smaller sized records (less than 1K per record), inline processing will be significantly faster on "in memory" namespaces. The server disables inline processing on disk based namespaces regardless of this policy field. Inline processing can introduce the possibility of unfairness because the server can process the entire batch before moving onto the next command. Default: true |
![]() | allowProleReads |
Allow read operations to use replicated data partitions instead of master
partition. By default, both read and write operations are directed to the
master partition.
This variable is currently only used in batch read/exists operations. For batch, this variable should only be set to true when the replication factor is greater than or equal to the number of nodes in the cluster. Default: false |
![]() | compress |
Use 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.
(Inherited from Policy.)This option will increase cpu and memory usage (for extra compressed buffers), but decrease the size of data sent over the network. Default: false |
![]() | failOnFilteredOut |
Throw exception if predExp is defined and that filter evaluates
to false (transaction ignored). The AerospikeException
will contain result code .
(Inherited from Policy.)This field is not applicable to batch, scan or query commands. Default: false |
![]() | maxConcurrentThreads |
Maximum number of concurrent synchronous batch request threads to server nodes at any point in time.
If there are 16 node/namespace combinations requested and maxConcurrentThreads is 8,
then batch requests will be made for 8 node/namespace combinations in parallel threads.
When a request completes, a new request will be issued until all 16 threads are complete.
Values:
Asynchronous batch requests ignore this field and always issue all node requests in parallel. Default: 1 |
![]() | maxRetries |
Maximum number of retries before aborting the current transaction.
The initial attempt is not counted as a retry.
(Inherited from Policy.)If maxRetries is exceeded, the transaction will abort with AerospikeException Timeout. WARNING: Database writes that are not idempotent (such as Add()) should not be retried because the write operation may be performed multiple times if the client timed out previous transaction attempts. It's important to use a distinct WritePolicy for non-idempotent writes which sets maxRetries = 0; Default for read: 2 (initial attempt + 2 retries = 3 attempts) Default for write/query/scan: 0 (no retries) |
![]() | predExp |
Optional predicate expression filter in postfix notation. If the predicate
expression exists and evaluates to false, the transaction is ignored.
(Inherited from Policy.)Default: null |
![]() | priority |
Priority of request relative to other transactions.
Currently, only used for scans.
(Inherited from Policy.) |
![]() | readModeAP |
Read policy for AP (availability) namespaces.
(Inherited from Policy.)Default: ONE |
![]() | readModeSC |
Read policy for SC (strong consistency) namespaces.
(Inherited from Policy.)Default: SESSION |
![]() | replica |
Replica algorithm used to determine the target node for a single record command.
Scan and query are not affected by replica algorithms.
(Inherited from Policy.)Default: SEQUENCE |
![]() | sendKey |
Send user defined key in addition to hash digest on both reads and writes.
If the key is sent on a write, the key will be stored with the record on
the server.
(Inherited from Policy.)Default: false (do not send the user defined key) |
![]() | sendSetName |
Send set name field to server for every key in the batch for batch index protocol.
This is only necessary when authentication is enabled and security roles are defined
on a per set basis.
Default: false |
![]() | sleepBetweenRetries |
Milliseconds to sleep between retries. Enter zero to skip sleep.
This field is ignored when maxRetries is zero.
This field is also ignored in async mode.
(Inherited from Policy.)The sleep only occurs on connection errors and server timeouts which suggest a node is down and the cluster is reforming. The sleep does not occur when the client's socketTimeout expires. Reads do not have to sleep when a node goes down because the cluster does not shut out reads during cluster reformation. The default for reads is zero. The default for writes is also zero because writes are not retried by default. Writes need to wait for the cluster to reform when a node goes down. Immediate write retries on node failure have been shown to consistently result in errors. If maxRetries is greater than zero on a write, then sleepBetweenRetries should be set high enough to allow the cluster to reform (>= 500ms). Default: 0 (do not sleep between retries) |
![]() | socketTimeout |
Socket idle timeout in milliseconds when processing a database command.
(Inherited from Policy.)If socketTimeout is zero and totalTimeout is non-zero, then socketTimeout will be set to totalTimeout. If both socketTimeout and totalTimeout are non-zero and socketTimeout > totalTimeout, then socketTimeout will be set to totalTimeout. If both socketTimeout and totalTimeout are zero, then there will be no socket idle limit. 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 transaction is retried. For synchronous methods, socketTimeout is the socket SendTimeout and ReceiveTimeout. For asynchronous methods, the socketTimeout is implemented using the AsyncTimeoutQueue and socketTimeout is only used if totalTimeout is not defined. Default: 30000ms |
![]() | totalTimeout |
Total transaction timeout in milliseconds.
(Inherited from Policy.)The totalTimeout is tracked on the client and sent to the server along with the transaction in the wire protocol. The client will most likely timeout first, but the server also has the capability to timeout the transaction. If totalTimeout is not zero and totalTimeout is reached before the transaction completes, the transaction will abort with AerospikeException Timeout. If totalTimeout is zero, there will be no total time limit. Default: 0 (no time limit) |