PartitionFilter Class

Aerospike
Partition filter used in scan/query. This filter is also used as a cursor.

If a previous scan/query returned all records specified by a PartitionFilter instance, a future scan/query using the same PartitionFilter instance will only return new records added after the last record read (in digest order) in each partition in the previous scan/query. To reset the cursor of an existing PartitionFilter instance, set Partitions to null.

Inheritance Hierarchy

SystemObject
  Aerospike.ClientPartitionFilter

Namespace:  Aerospike.Client
Assembly:  AerospikeClient (in AerospikeClient.dll) Version: 5.3.2.0 (5.3.2)
Syntax

C#
[SerializableAttribute]
public sealed class PartitionFilter

The PartitionFilter type exposes the following members.

Properties

  NameDescription
Public propertyBegin
First partition id.
Public propertyCount
Count of partitions.
Public propertyDigest
Resume after digest.
Public propertyDone
If using maxRecords or maxRecords, did previous paginated scans with this partition filter instance return all records?
Public propertyPartitions
Cursor status of each partition after scan termination. The cursor contains the last record read for each partition and is usually obtained from Partitions after a previous scan/query. This is useful for a retry of a partially completed scan/query.

If a previous scan/query returned all records specified by a PartitionFilter instance, a future scan/query using the same PartitionFilter instance will only return new records added after the last record read (in digest order) in each partition in the previous scan/query. To reset the cursor of an existing PartitionFilter instance, set Partitions to null.

The partition status is accurate for sync/async ScanPartitions and async QueryPartitions.

The partition status may not be accurate for QueryPartitions(QueryPolicy, Statement, PartitionFilter) because the last digest received is set during query parsing, but the user may not have retrieved that digest from the RecordSet yet.

Top
Methods

  NameDescription
Public methodStatic memberAfter
Return records after key's digest in partition containing the digest. Note that digest order is not the same as userKey order. This method only works for scan or query with null filter.
Public methodStatic memberAll
Read all partitions.
Public methodStatic memberId
Filter by partition id.
Public methodStatic memberRange
Filter by partition range.
Top
See Also

Reference