﻿MapExp Methods

MapExp Methods

Aerospike

The MapExp type exposes the following members.

Methods

NameDescription
Clear
Create expression that removes all items in map.
GetByIndex
Create expression that selects map item identified by index and returns selected data specified by returnType.
GetByIndexRange(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.
GetByIndexRange(MapReturnType, Exp, Exp, Exp, CTX)
Create expression that selects "count" map items starting at specified index and returns selected data specified by returnType.
GetByKey
Create expression that selects map item identified by key and returns selected data specified by returnType.
GetByKeyList
Create expression that selects map items identified by keys and returns selected data specified by returnType.
GetByKeyRange
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.

GetByKeyRelativeIndexRange(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}]

GetByKeyRelativeIndexRange(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}]

GetByRank
Create expression that selects map item identified by rank and returns selected data specified by returnType.
GetByRankRange(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.
GetByRankRange(MapReturnType, Exp, Exp, Exp, CTX)
Create expression that selects "count" map items starting at specified rank and returns selected data specified by returnType.
GetByValue
Create expression that selects map items identified by value and returns selected data specified by returnType.
GetByValueList
Create expression that selects map items identified by values and returns selected data specified by returnType.
GetByValueRange
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.

GetByValueRelativeRankRange(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}]

GetByValueRelativeRankRange(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}]

Increment
Create expression that increments values by incr for all items identified by key. Valid only for numbers.
Put
Create expression that writes key/value item to map bin.
PutItems
Create expression that writes each map item to map bin.
RemoveByIndex
Create expression that removes map item identified by index.
RemoveByIndexRange(Exp, Exp, CTX)
Create expression that removes map items starting at specified index to the end of map.
RemoveByIndexRange(Exp, Exp, Exp, CTX)
Create expression that removes "count" map items starting at specified index.
RemoveByKey
Create expression that removes map item identified by key.
RemoveByKeyList
Create expression that removes map items identified by keys.
RemoveByKeyRange
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.
RemoveByKeyRelativeIndexRange(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}]

RemoveByKeyRelativeIndexRange(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}]

RemoveByRank
Create expression that removes map item identified by rank.
RemoveByRankRange(Exp, Exp, CTX)
Create expression that removes map items starting at specified rank to the last ranked item.
RemoveByRankRange(Exp, Exp, Exp, CTX)
Create expression that removes "count" map items starting at specified rank.
RemoveByValue
Create expression that removes map items identified by value.
RemoveByValueList
Create expression that removes map items identified by values.
RemoveByValueRange
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.
RemoveByValueRelativeRankRange(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}]

RemoveByValueRelativeRankRange(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}]

Size
Create expression that returns list size.
Top