com.aerospike.client.policy

Class BatchPolicy

java.lang.Object

com.aerospike.client.policy.Policy

com.aerospike.client.policy.BatchPolicy

public final class BatchPolicy
extends Policy

Configuration variables for multi-record get and exist requests.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	allowInline Allow batch to be processed immediately in the server's receiving thread when the server deems it to be appropriate.
int	maxConcurrentThreads Maximum number of concurrent synchronous batch request threads to server nodes at any point in time.
boolean	sendSetName Send set name field to server for every key in the batch for batch index protocol.
boolean	useBatchDirect Use old batch direct protocol where batch reads are handled by direct low-level batch server database routines.

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

consistencyLevel, linearizeRead, maxRetries, priority, replica, sendKey, sleepBetweenRetries, socketTimeout, timeoutDelay, totalTimeout

Constructor Summary

Constructors

Constructor and Description
BatchPolicy() Default constructor.
BatchPolicy(BatchPolicy other) Copy batch policy from another batch policy.
BatchPolicy(Policy other) Copy batch policy from another policy.

Method Summary

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

setTimeout, setTimeouts

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

maxConcurrentThreads

public int 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 requests are complete.

Values:

• 1: Issue batch requests sequentially. This mode has a performance advantage for small to medium sized batch sizes because requests can be issued in the main transaction thread. This is the default.
• 0: Issue all batch requests in parallel threads. This mode has a performance advantage for extremely large batch sizes because each node can process the request immediately. The downside is extra threads will need to be created (or taken from a thread pool).
• > 0: Issue up to maxConcurrentThreads batch requests in parallel threads. When a request completes, a new request will be issued until all requests are complete. This mode prevents too many parallel threads being created for large cluster implementations. The downside is extra threads will still need to be created (or taken from a thread pool).

Asynchronous batch requests ignore this field and always issue all node requests in parallel.

useBatchDirect

public boolean useBatchDirect

Use old batch direct protocol where batch reads are handled by direct low-level batch server database routines. The batch direct protocol can be faster when there is a single namespace, but there is one important drawback. The batch direct protocol will not proxy to a different server node when the mapped node has migrated a record to another node (resulting in not found record).

This can happen after a node has been added/removed from the cluster and there is a lag between records being migrated and client partition map update (once per second).

The new batch index protocol will perform this record proxy when necessary. Default: false (use new batch index protocol if server supports it)

allowInline

public boolean 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 (<= 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

sendSetName

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

Constructor Detail

BatchPolicy

public BatchPolicy(BatchPolicy other)

Copy batch policy from another batch policy.

BatchPolicy

public BatchPolicy(Policy other)

Copy batch policy from another policy.

BatchPolicy

public BatchPolicy()

Default constructor.