ScanPolicy Class
Scan policy attributes used by queries.
Scan requests are send completely using proto buffers and hence include all policy attributes.
Namespace: Aerospike.Client.KVSAssembly: AerospikeClient (in AerospikeClient.dll) Version: 7.0.0
public sealed class ScanPolicy : IMessage<ScanPolicy>,
IMessage, IEquatable<ScanPolicy>, IDeepCloneable<ScanPolicy>,
IBufferMessage
- Inheritance
- Object ScanPolicy
- Implements
- IBufferMessage, IDeepCloneableScanPolicy, IMessage, IMessageScanPolicy, IEquatableScanPolicy
Compress |
Use zlib compression on command buffers sent to the server and responses received
from the server when the buffer size is greater than 128 bytes.
This option will increase cpu and memory usage (for extra compressed buffers),but
decrease the size of data sent over the network.
|
ConcurrentNodes |
Should scan requests be issued in parallel.
Default: true
|
Descriptor | |
Expression |
Optional expression filter. If filterExp exists and evaluates to false, the
transaction is ignored.
|
HasConcurrentNodes | Gets whether the "concurrentNodes" field is set |
HasExpression | Gets whether the "expression" field is set |
HasIncludeBinData | Gets whether the "includeBinData" field is set |
HasMaxConcurrentNodes | Gets whether the "maxConcurrentNodes" field is set |
HasMaxRecords | Gets whether the "maxRecords" field is set |
HasRecordsPerSecond | Gets whether the "recordsPerSecond" field is set |
HasTotalTimeout | Gets whether the "totalTimeout" field is set |
IncludeBinData |
Should bin data be retrieved. If false, only record digests (and user keys
if stored on the server) are retrieved.
Default: true
|
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 queries
will be made to 8 nodes in parallel. When a scan completes, a new scan will
be issued until all 16 nodes have been queried.
Default: 0 (issue requests to all server nodes in parallel)
|
MaxRecords |
Approximate 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.
Default: 0 (do not limit record count)
|
Parser | |
ReadModeAP |
Read policy for SC (strong consistency) namespaces.
|
ReadModeSC |
Replica algorithm used to determine the target node
for a single record command.
Scan and scan are not affected by replica algorithms.
|
RecordsPerSecond |
Limit returned records per second (rps) rate for each server.
Do not apply rps limit if recordsPerSecond is zero.
Default: 0
|
Replica |
Read policy for AP (availability) namespaces.
|
TotalTimeout |
Total transaction timeout in milliseconds.
Default for all other commands: 1000ms
|