The ScanPolicy type exposes the following members.
Back to Top
Fields
Name | Description | |
---|---|---|
![]() | 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.
(Inherited from Policy.)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. |
![]() | concurrentNodes |
Issue scan requests in parallel or serially.
|
![]() | consistencyLevel |
How replicas should be consulted in a read operation to provide the desired
consistency guarantee. Default to allowing one replica to be used in the
read operation.
(Inherited from Policy.) |
![]() | failOnClusterChange |
Terminate scan if cluster in fluctuating state.
|
![]() | includeBinData |
Indicates if bin data is retrieved. If false, only record digests are retrieved.
|
![]() | maxConcurrentNodes |
Maximum number of concurrent requests to server nodes at any point in time.
If there are 16 nodes in the cluster and maxConcurrentNodes is 8, then scan requests
will be made to 8 nodes in parallel. When a scan completes, a new scan request will
be issued until all 16 nodes have been scanned.
This field is only relevant when concurrentNodes is true. Default (0) is to issue requests to all server nodes in parallel. |
![]() | maxRetries |
Maximum number of retries before aborting the current transaction.
A retry is attempted when there is a network error other than timeout.
If maxRetries is exceeded, the abort will occur even if the timeout
has not yet been exceeded. The default number of retries is 1.
(Inherited from Policy.) |
![]() | priority |
Priority of request relative to other transactions.
Currently, only used for scans.
(Inherited from Policy.) |
![]() | scanPercent |
Percent of data to scan. Valid integer range is 1 to 100.
Default is 100.
|
![]() | sendKey |
Send user defined key in addition to hash digest on both reads and writes.
The default is to not send the user defined key.
(Inherited from Policy.) |
![]() | sleepBetweenRetries |
Milliseconds to sleep between retries if a transaction fails and the
timeout was not exceeded. The default sleep between retries is 500 ms.
(Inherited from Policy.) |
![]() | timeout |
Total transaction timeout in milliseconds for both client and server.
The timeout is tracked on the client and also sent to the server along
with the transaction in the wire protocol. The client will most likely
timeout first, but the server has the capability to timeout the transaction
as well.
(Inherited from Policy.)The timeout is also used as a socket timeout. Retries will not occur if the timeout limit has been reached. Default to no timeout (0). |
See Also