MapExp Class

Aerospike
Map expression generator. See Exp.

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.

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

Inheritance Hierarchy

SystemObject
  Aerospike.ClientMapExp

Namespace:  Aerospike.Client
Assembly:  AerospikeClient (in AerospikeClient.dll) Version: 5.1.1.0 (5.1.1)
Syntax

C#
public sealed class MapExp

The MapExp type exposes the following members.

Constructors

  NameDescription
Public methodMapExp
Initializes a new instance of the MapExp class
Top
Methods

  NameDescription
Public methodStatic memberClear
Create expression that removes all items in map.
Public methodStatic memberGetByIndex
Create expression that selects map item identified by index and returns selected data specified by returnType.
Public methodStatic memberGetByIndexRange(MapReturnType, Exp, Exp, CTX)
Create expression that selects map items starting at specified index to the end of map and returns selected data specified by returnType.
Public methodStatic memberGetByIndexRange(MapReturnType, Exp, Exp, Exp, CTX)
Create expression that selects "count" map items starting at specified index and returns selected data specified by returnType.
Public methodStatic memberCode exampleGetByKey
Create expression that selects map item identified by key and returns selected data specified by returnType.
Public methodStatic memberGetByKeyList
Create expression that selects map items identified by keys and returns selected data specified by returnType.
Public methodStatic memberGetByKeyRange
Create expression that selects map items identified by key range (keyBegin inclusive, keyEnd exclusive). If keyBegin is null, the range is less than keyEnd. If keyEnd is null, the range is greater than equal to keyBegin.

Expression returns selected data specified by returnType.

Public methodStatic memberGetByKeyRelativeIndexRange(MapReturnType, Exp, Exp, Exp, CTX)
Create expression that selects map items nearest to key and greater by index. Expression returns selected data specified by returnType.

Examples for ordered map [{0=17},{4=2},{5=15},{9=10}]:

  • (value,index) = [selected items]
  • (5,0) = [{5=15},{9=10}]
  • (5,1) = [{9=10}]
  • (5,-1) = [{4=2},{5=15},{9=10}]
  • (3,2) = [{9=10}]
  • (3,-2) = [{0=17},{4=2},{5=15},{9=10}]

Public methodStatic memberGetByKeyRelativeIndexRange(MapReturnType, Exp, Exp, Exp, Exp, CTX)
Create expression that selects map items nearest to key and greater by index with a count limit. Expression returns selected data specified by returnType.

Examples for ordered map [{0=17},{4=2},{5=15},{9=10}]:

  • (value,index,count) = [selected items]
  • (5,0,1) = [{5=15}]
  • (5,1,2) = [{9=10}]
  • (5,-1,1) = [{4=2}]
  • (3,2,1) = [{9=10}]
  • (3,-2,2) = [{0=17}]

Public methodStatic memberGetByRank
Create expression that selects map item identified by rank and returns selected data specified by returnType.
Public methodStatic memberGetByRankRange(MapReturnType, Exp, Exp, CTX)
Create expression that selects map items starting at specified rank to the last ranked item and returns selected data specified by returnType.
Public methodStatic memberGetByRankRange(MapReturnType, Exp, Exp, Exp, CTX)
Create expression that selects "count" map items starting at specified rank and returns selected data specified by returnType.
Public methodStatic memberCode exampleGetByValue
Create expression that selects map items identified by value and returns selected data specified by returnType.
Public methodStatic memberGetByValueList
Create expression that selects map items identified by values and returns selected data specified by returnType.
Public methodStatic memberGetByValueRange
Create expression that selects map items identified by value range (valueBegin inclusive, valueEnd exclusive) If valueBegin is null, the range is less than valueEnd. If valueEnd is null, the range is greater than equal to valueBegin.

Expression returns selected data specified by returnType.

Public methodStatic memberGetByValueRelativeRankRange(MapReturnType, Exp, Exp, Exp, CTX)
Create expression that selects map items nearest to value and greater by relative rank. Expression returns selected data specified by returnType.

Examples for map [{4=2},{9=10},{5=15},{0=17}]:

  • (value,rank) = [selected items]
  • (11,1) = [{0=17}]
  • (11,-1) = [{9=10},{5=15},{0=17}]

Public methodStatic memberGetByValueRelativeRankRange(MapReturnType, Exp, Exp, Exp, Exp, CTX)
Create expression that selects map items nearest to value and greater by relative rank with a count limit. Expression returns selected data specified by returnType.

Examples for map [{4=2},{9=10},{5=15},{0=17}]:

  • (value,rank,count) = [selected items]
  • (11,1,1) = [{0=17}]
  • (11,-1,1) = [{9=10}]

Public methodStatic memberIncrement
Create expression that increments values by incr for all items identified by key. Valid only for numbers.
Public methodStatic memberPut
Create expression that writes key/value item to map bin.
Public methodStatic memberPutItems
Create expression that writes each map item to map bin.
Public methodStatic memberRemoveByIndex
Create expression that removes map item identified by index.
Public methodStatic memberRemoveByIndexRange(Exp, Exp, CTX)
Create expression that removes map items starting at specified index to the end of map.
Public methodStatic memberRemoveByIndexRange(Exp, Exp, Exp, CTX)
Create expression that removes "count" map items starting at specified index.
Public methodStatic memberRemoveByKey
Create expression that removes map item identified by key.
Public methodStatic memberRemoveByKeyList
Create expression that removes map items identified by keys.
Public methodStatic memberRemoveByKeyRange
Create expression that removes map items identified by key range (keyBegin inclusive, keyEnd exclusive). If keyBegin is null, the range is less than keyEnd. If keyEnd is null, the range is greater than equal to keyBegin.
Public methodStatic memberRemoveByKeyRelativeIndexRange(Exp, Exp, Exp, CTX)
Create expression that removes map items nearest to key and greater by index.

Examples for map [{0=17},{4=2},{5=15},{9=10}]:

  • (value,index) = [removed items]
  • (5,0) = [{5=15},{9=10}]
  • (5,1) = [{9=10}]
  • (5,-1) = [{4=2},{5=15},{9=10}]
  • (3,2) = [{9=10}]
  • (3,-2) = [{0=17},{4=2},{5=15},{9=10}]

Public methodStatic memberRemoveByKeyRelativeIndexRange(Exp, Exp, Exp, Exp, CTX)
Create expression that removes map items nearest to key and greater by index with a count limit.

Examples for map [{0=17},{4=2},{5=15},{9=10}]:

  • (value,index,count) = [removed items]
  • (5,0,1) = [{5=15}]
  • (5,1,2) = [{9=10}]
  • (5,-1,1) = [{4=2}]
  • (3,2,1) = [{9=10}]
  • (3,-2,2) = [{0=17}]

Public methodStatic memberRemoveByRank
Create expression that removes map item identified by rank.
Public methodStatic memberRemoveByRankRange(Exp, Exp, CTX)
Create expression that removes map items starting at specified rank to the last ranked item.
Public methodStatic memberRemoveByRankRange(Exp, Exp, Exp, CTX)
Create expression that removes "count" map items starting at specified rank.
Public methodStatic memberRemoveByValue
Create expression that removes map items identified by value.
Public methodStatic memberRemoveByValueList
Create expression that removes map items identified by values.
Public methodStatic memberRemoveByValueRange
Create expression that removes map items identified by value range (valueBegin inclusive, valueEnd exclusive). If valueBegin is null, the range is less than valueEnd. If valueEnd is null, the range is greater than equal to valueBegin.
Public methodStatic memberRemoveByValueRelativeRankRange(Exp, Exp, Exp, CTX)
Create expression that removes map items nearest to value and greater by relative rank.

Examples for map [{4=2},{9=10},{5=15},{0=17}]:

  • (value,rank) = [removed items]
  • (11,1) = [{0=17}]
  • (11,-1) = [{9=10},{5=15},{0=17}]

Public methodStatic memberRemoveByValueRelativeRankRange(Exp, Exp, Exp, Exp, CTX)
Create expression that removes map items nearest to value and greater by relative rank with a count limit.

Examples for map [{4=2},{9=10},{5=15},{0=17}]:

  • (value,rank,count) = [removed items]
  • (11,1,1) = [{0=17}]
  • (11,-1,1) = [{9=10}]

Public methodStatic memberCode exampleSize
Create expression that returns list size.
Top
See Also

Reference