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

Batch parent policy.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	allowInline Allow batch to be processed immediately in the server's receiving thread for in-memory namespaces.
boolean	allowInlineSSD Allow batch to be processed immediately in the server's receiving thread for SSD namespaces.
int	maxConcurrentThreads Maximum number of concurrent synchronous batch node request threads to server nodes.
boolean	respondAllKeys Should all batch keys be attempted regardless of errors.
boolean	sendSetName Deprecated.

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

compress, connectTimeout, failOnFilteredOut, filterExp, maxRetries, readModeAP, readModeSC, 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

Modifier and Type	Method and Description
static BatchPolicy	ReadDefault() Default batch read policy.
void	setAllowInline(boolean allowInline)
void	setAllowInlineSSD(boolean allowInlineSSD)
void	setMaxConcurrentThreads(int maxConcurrentThreads)
void	setRespondAllKeys(boolean respondAllKeys)
static BatchPolicy	WriteDefault() Default batch write policy.

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

equals, hashCode, setCompress, setConnectTimeout, setFailOnFilteredOut, setFilterExp, setMaxRetries, setReadModeAP, setReadModeSC, setReplica, setSendKey, setSleepBetweenRetries, setSocketTimeout, setTimeout, setTimeoutDelay, setTimeouts, setTotalTimeout

Methods inherited from class java.lang.Object

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

Field Detail

maxConcurrentThreads

public int maxConcurrentThreads

Maximum number of concurrent synchronous batch node request threads to server nodes. Asynchronous batch requests ignore this field and always issue all node requests in parallel.

The batch is split into requests for each node according to the node assignment of each batch key. The number of batch node requests is always less or equal to the cluster size.

If there are 16 batch node requests and maxConcurrentThreads is 8, then batch requests will be made for 8 nodes in parallel threads. When a request completes, a new request will be issued until all 16 requests are complete. If there are 4 batch node requests and maxConcurrentThreads is 8, then only 4 batch requests will be made for 4 nodes in parallel threads.

Values:

• 1 (default): Issue batch node requests sequentially. This mode has a performance advantage for small batch sizes because requests can be issued in the main transaction thread without using a thread pool. This mode is not optimal for batch requests spread out over many nodes in a large cluster.
• 0: Issue all batch node requests in parallel threads. This mode has a performance advantage for 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). In extreme cases, the operating system's thread capacity could be exhausted.
• > 0: Issue up to maxConcurrentThreads batch node 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 clusters. The downside is extra threads will still need to be created (or taken from a thread pool). A typical value is the number of cpu cores available on the client machine.

Default: 1

allowInline

public boolean allowInline

Allow batch to be processed immediately in the server's receiving thread for in-memory namespaces. If false, the batch will always be processed in separate service threads.

For batch transactions with smaller sized records (<= 1K per record), inline processing will be significantly faster on in-memory namespaces.

Inline processing can introduce the possibility of unfairness because the server can process the entire batch before moving onto the next command.

Default: true

allowInlineSSD

public boolean allowInlineSSD

Allow batch to be processed immediately in the server's receiving thread for SSD namespaces. If false, the batch will always be processed in separate service threads. Server versions < 6.0 ignore this field.

Inline processing can introduce the possibility of unfairness because the server can process the entire batch before moving onto the next command.

Default: false

respondAllKeys

public boolean respondAllKeys

Should all batch keys be attempted regardless of errors. This field is used on both the client and server. The client handles node specific errors and the server handles key specific errors.

If true, every batch key is attempted regardless of previous key specific errors. Node specific errors such as timeouts stop keys to that node, but keys directed at other nodes will continue to be processed.

If false, the server will stop the batch to its node on most key specific errors. The exceptions are ResultCode.KEY_NOT_FOUND_ERROR and ResultCode.FILTERED_OUT which never stop the batch. The client will stop the entire batch on node specific errors for sync commands that are run in sequence (maxConcurrentThreads == 1). The client will not stop the entire batch for async commands or sync commands run in parallel.

Server versions < 6.0 do not support this field and treat this value as false for key specific errors.

Default: true

sendSetName

@Deprecated
public boolean sendSetName

Deprecated.

This method is deprecated and will eventually be removed. The set name is now always sent for every distinct namespace/set in the batch.

Send set name field to server for every key in the batch for batch index protocol. This is necessary for batch writes and batch reads 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.

Method Detail

ReadDefault

public static BatchPolicy ReadDefault()

Default batch read policy.

WriteDefault

public static BatchPolicy WriteDefault()

Default batch write policy.

setMaxConcurrentThreads

public void setMaxConcurrentThreads(int maxConcurrentThreads)

setAllowInline

public void setAllowInline(boolean allowInline)

setAllowInlineSSD

public void setAllowInlineSSD(boolean allowInlineSSD)

setRespondAllKeys

public void setRespondAllKeys(boolean respondAllKeys)