Aerospike.Client Namespace

This client is thread-safe. One client instance should be used per cluster. Multiple threads should share this cluster instance.

Your application uses this class API to perform database operations such as writing and reading records, and selecting sets of records. Write operations include specialized functionality such as append/prepend and arithmetic addition.

Each record may have multiple bins, unless the Aerospike server nodes are configured as "single-bin". In "multi-bin" mode, partial records may be written or read by specifying the relevant subset of bins.

Your application uses this class to perform asynchronous database operations such as writing and reading records, and selecting sets of records. Write operations include specialized functionality such as append/prepend and arithmetic addition.

This client is thread-safe. One client instance should be used per cluster. Multiple threads should share this cluster instance.

Each record may have multiple bins, unless the Aerospike server nodes are configured as "single-bin". In "multi-bin" mode, partial records may be written or read by specifying the relevant subset of bins.

The bin expression argument in these methods can be a reference to a bin or the result of another expression. Expressions that modify bin values are only used for temporary expression evaluation and are not permanently applied to the bin. Bit modify expressions return the blob bin's value.

Offset orientation is left-to-right. Negative offsets are supported. If the offset is negative, the offset starts backwards from end of the bitmap. If an offset is out of bounds, a parameter error will be returned.

Bit operations on bitmap items nested in lists/maps are not currently supported by the server.

The bin expression argument in these methods can be a reference to a bin or the result of another expression. Expressions that modify bin values are only used for temporary expression evaluation and are not permanently applied to the bin. HLL modify expressions return the HLL bin's value.

HyperLogLog operations on HLL items nested in lists/maps are not currently supported by the server.

The info protocol is a name/value pair based system, where an individual database server node is queried to determine its configuration and status. The list of supported names can be found at:

https://www.aerospike.com/docs/reference/info/index.html

The bin expression argument in these methods can be a reference to a bin or the result of another expression. Expressions that modify bin values are only used for temporary expression evaluation and are not permanently applied to the bin.

List modify expressions return the bin's value. This value will be a list except when the list is nested within a map. In that case, a map is returned for the list modify expression.

List expressions support negative indexing. If the index is negative, the resolved index starts backwards from end of list. If an index is out of bounds, a parameter error will be returned. If a range is partially out of bounds, the valid part of the range will be returned. Index/Range examples:

• Index 0: First item in list.
• Index 4: Fifth item in list.
• Index -1: Last item in list.
• Index -3: Third to last item in list.
• Index 1 Count 2: Second and third items in list.
• Index -3 Count 3: Last three items in list.
• Index -5 Count 4: Range between fifth to last item to second to last item inclusive.

Nested expressions are supported by optional CTX context arguments. Example:

• bin = [[7,9,5],[1,2,3],[6,5,4,1]]
• Get size of last list.
• ListExp.size(Exp.ListBin("bin"), CTX.listIndex(-1))
• result = 4

List operations support negative indexing. If the index is negative, the resolved index starts backwards from end of list. If an index is out of bounds, a parameter error will be returned. If a range is partially out of bounds, the valid part of the range will be returned. Index/Range examples:

• Index 0: First item in list.
• Index 4: Fifth item in list.
• Index -1: Last item in list.
• Index -3: Third to last item in list.
• Index 1 Count 2: Second and third items in list.
• Index -3 Count 3: Last three items in list.
• Index -5 Count 4: Range between fifth to last item to second to last item inclusive.

Nested CDT operations are supported by optional CTX context arguments. Examples:

• bin = [[7,9,5],[1,2,3],[6,5,4,1]]
• Append 11 to last list.
• ListOperation.append("bin", Value.Get(11), CTX.listIndex(-1))
• bin result = [[7,9,5],[1,2,3],[6,5,4,1,11]]
• bin = {key1=[[7,9,5],[13]], key2=[[9],[2,4],[6,1,9]], key3=[[6,5]]}
• Append 11 to lowest ranked list in map identified by "key2".
• ListOperation.append("bin", Value.Get(11), CTX.mapKey(Value.Get("key2")), CTX.listRank(0))
• bin result = {key1=[[7,9,5],[13]], key2=[[9],[2,4,11],[6,1,9]], key3=[[6,5]]}

The bin expression argument in these methods can be a reference to a bin or the result of another expression. Expressions that modify bin values are only used for temporary expression evaluation and are not permanently applied to the bin.

Map modify expressions return the bin's value. This value will be a map except when the map is nested within a list. In that case, a list is returned for the map modify expression.

Valid map key types are:

• string
• integer
• byte[]

All maps maintain an index and a rank. The index is the item offset from the start of the map, for both unordered and ordered maps. The rank is the sorted index of the value component. Map supports negative indexing for index and rank.

Index examples:

• Index 0: First item in map.
• Index 4: Fifth item in map.
• Index -1: Last item in map.
• Index -3: Third to last item in map.
• Index 1 Count 2: Second and third items in map.
• Index -3 Count 3: Last three items in map.
• Index -5 Count 4: Range between fifth to last item to second to last item inclusive.

Rank examples:

• Rank 0: Item with lowest value rank in map.
• Rank 4: Fifth lowest ranked item in map.
• Rank -1: Item with highest ranked value in map.
• Rank -3: Item with third highest ranked value in map.
• Rank 1 Count 2: Second and third lowest ranked items in map.
• Rank -3 Count 3: Top three ranked items in map.

Nested expressions are supported by optional CTX context arguments. Example:

• bin = {key1={key11=9,key12=4}, key2={key21=3,key22=5}}
• Set map value to 11 for map key "key21" inside of map key "key2".
• Get size of map key2.
• MapExp.size(Exp.MapBin("bin"), CTX.mapKey(Value.get("key2"))
• result = 2

• string
• integer
• byte[]

All maps maintain an index and a rank. The index is the item offset from the start of the map, for both unordered and ordered maps. The rank is the sorted index of the value component. Map supports negative indexing for index and rank.

Index examples:

• Index 0: First item in map.
• Index 4: Fifth item in map.
• Index -1: Last item in map.
• Index -3: Third to last item in map.
• Index 1 Count 2: Second and third items in map.
• Index -3 Count 3: Last three items in map.
• Index -5 Count 4: Range between fifth to last item to second to last item inclusive.

Rank examples:

• Rank 0: Item with lowest value rank in map.
• Rank 4: Fifth lowest ranked item in map.
• Rank -1: Item with highest ranked value in map.
• Rank -3: Item with third highest ranked value in map.
• Rank 1 Count 2: Second and third lowest ranked items in map.
• Rank -3 Count 3: Top three ranked items in map.

Nested CDT operations are supported by optional CTX context arguments. Examples:

• bin = {key1={key11=9,key12=4}, key2={key21=3,key22=5}}
• Set map value to 11 for map key "key21" inside of map key "key2".
• MapOperation.put(MapPolicy.Default, "bin", Value.Get("key21"), Value.Get(11), CTX.mapKey(Value.Get("key2")))
• bin result = {key1={key11=9,key12=4},key2={key21=11,key22=5}}
• bin = {key1={key11={key111=1},key12={key121=5}}, key2={key21={"key211",7}}}
• Set map value to 11 in map key "key121" for highest ranked map ("key12") inside of map key "key1".
• MapOperation.put(MapPolicy.Default, "bin", Value.Get("key121"), Value.Get(11), CTX.mapKey(Value.Get("key1")), CTX.mapRank(-1))
• bin result = {key1={key11={key111=1},key12={key121=11}}, key2={key21={"key211",7}}}

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.

Secure connections are not supported for asynchronous commands because AsyncClient uses the best performing SocketAsyncEventArgs. Unfortunately, SocketAsyncEventArgs is not supported by the provided SslStream.

Your application uses this interface to perform asynchronous database operations such as writing and reading records, and selecting sets of records. Write operations include specialized functionality such as append/prepend and arithmetic addition.

Clients implementing this interface must be thread-safe. One client instance should be used per cluster. Multiple threads should share same cluster instance.

Each record may have multiple bins, unless the Aerospike server nodes are configured as "single-bin". In "multi-bin" mode, partial records may be written or read by specifying the relevant subset of bins.

If concurrentNodes is true and maxConcurrentNodes is not equal one, then your scan callback implementation must be thread safe.

How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.

Determines SC read consistency options.