Module: aerospike/exp/maps

The aerospike/exp/maps module defines functions for expressions on the Map datatype.

Source:

Methods


<static> clear(ctx, bin)

Create expression that removes all items in map.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(map expression)

Type
AerospikeExp

<static> getByIndex(ctx, returnType, valueType, idx, bin)

Create expression that selects map item identified by index and returns selected data specified by returnType.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

returnType AerospikeExp

Return type.

valueType AerospikeExp

expression value type.

idx AerospikeExp

Index integer expression.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(expression)

Type
AerospikeExp

<static> getByIndexRange(ctx, returnType, idx, count, bin)

Create expression that selects "count" map items starting at specified index and returns selected data specified by returnType.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

returnType AerospikeExp

Return type.

idx AerospikeExp

Index integer expression.

count AerospikeExp

Count integer expression.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(expression)

Type
AerospikeExp

<static> getByIndexRangeToEnd(ctx, returnType, idx, bin)

Create expression that selects map items starting at specified index to the end of map and returns selected data specified by returnType.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

returnType AerospikeExp

Return type.

idx AerospikeExp

Index integer expression.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(expression)

Type
AerospikeExp

<static> getByKey(ctx, returnType, valueType, key, bin)

Create expression that selects map item identified by key and returns selected data specified by returnType.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

returnType AerospikeExp

Return type.

valueType AerospikeExp

expression value type.

key AerospikeExp

Key expression.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(expression)

Type
AerospikeExp

<static> getByKeyList(ctx, returnType, keys, bin)

Create expression that selects map items identified by keys and returns selected data specified by returnType.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

returnType AerospikeExp

Return type.

keys AerospikeExp

Keys list expression.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(expression)

Type
AerospikeExp

<static> getByKeyRange(ctx, returnType, begin, end, bin)

Create expression that selects map items identified by key range (begin inclusive, end exclusive). If begin is nil, the range is less than end. If end is infinity, the range is greater than equal to begin. Expression returns selected data specified by returnType.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

returnType AerospikeExp

Return type.

begin AerospikeExp

Begin key expression.

end AerospikeExp

End key expression.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(expression)

Type
AerospikeExp

<static> getByKeyRelIndexRange(ctx, returnType, key, idx, count, bin)

Create expression that selects map items nearest to key and greater by index with a count limit. Expression returns selected data specified by returnType.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

returnType AerospikeExp

Return type.

key AerospikeExp

Key expression.

idx AerospikeExp

Index integer expression.

count AerospikeExp

Count integer expression.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(expression)

Type
AerospikeExp

<static> getByKeyRelIndexRangeToEnd(ctx, returnType, key, idx, bin)

Create expression that selects map items nearest to key and greater by index and returns selected data specified by returnType.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

returnType AerospikeExp

Return type.

key AerospikeExp

Key expression.

idx AerospikeExp

Index integer expression.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(expression)

Type
AerospikeExp

<static> getByRank(ctx, returnType, valueType, rank, bin)

Create expression that selects map item identified by rank and returns selected data specified by returnType.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

returnType AerospikeExp

Return type.

valueType AerospikeExp

expression value type.

rank AerospikeExp

Rank integer expression.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(expression)

Type
AerospikeExp

<static> getByRankRange(ctx, returnType, rank, count, bin)

Create expression that selects "count" map items starting at specified rank and returns selected data specified by returnType.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

returnType AerospikeExp

Return type.

rank AerospikeExp

Rank integer expression.

count AerospikeExp

Count integer expression.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(expression)

Type
AerospikeExp

<static> getByRankRangeToEnd(ctx, returnType, rank, bin)

Create expression that selects map items starting at specified rank to the last ranked item and returns selected data specified by returnType.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

returnType AerospikeExp

Return type.

rank AerospikeExp

Rank integer expression.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(expression)

Type
AerospikeExp

<static> getByValue(ctx, returnType, value, bin)

Create expression that selects map items identified by value and returns selected data specified by returnType.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

returnType AerospikeExp

Return type.

value AerospikeExp

Value expression.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(expression)

Type
AerospikeExp

<static> getByValueList(ctx, returnType, values, bin)

Create expression that selects map items identified by values and returns selected data specified by returnType.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

returnType AerospikeExp

Return type.

values AerospikeExp

Values list expression.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(expression)

Type
AerospikeExp

<static> getByValueRange(ctx, returnType, begin, end, bin)

Create expression that selects map items identified by value range (begin inclusive, end exclusive). If begin is nil, the range is less than end. If end is infinity, the range is greater than equal to begin. Expression returns selected data specified by returnType.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

returnType AerospikeExp

Return type.

begin AerospikeExp

Begin value expression.

end AerospikeExp

End value expression.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(expression)

Type
AerospikeExp

<static> getByValueRelRankRange(ctx, returnType, value, rank, count, bin)

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.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

returnType AerospikeExp

Return type.

value AerospikeExp

Value expression.

rank AerospikeExp

Rank integer expression.

count AerospikeExp

Count integer expression.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(expression)

Type
AerospikeExp

<static> getByValueRelRankRangeToEnd(ctx, returnType, value, rank, bin)

Create expression that selects map items nearest to value and greater by relative rank. Expression returns selected data specified by returnType.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

returnType AerospikeExp

Return type.

value AerospikeExp

Value expression.

rank AerospikeExp

Rank integer expression.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(expression)

Type
AerospikeExp

<static> increment(ctx, policy, key, value, bin)

Create expression that increments values by incr for all items identified by key. Valid only for numbers.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

policy Object

Optional map write policy.

key AerospikeExp

Key expression.

value AerospikeExp

Increment value number expression.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(map expression)

Type
AerospikeExp

<static> put(ctx, policy, key, value, bin)

Create expression that writes key/val item to map bin.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

policy Object

Optional map write policy.

key AerospikeExp

Key expression.

value AerospikeExp

Value expression.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(map expression)

Type
AerospikeExp

<static> putItems(ctx, policy, map, bin)

Create expression that writes each map item to map bin.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

policy Object

Optional map write policy.

map AerospikeExp

Source map expression.

bin AerospikeExp

Target map bin or map value expression.

Source:
Returns:

(map expression)

Type
AerospikeExp

<static> removeByIndex(ctx, idx, bin)

Create expression that removes map item identified by index.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

idx AerospikeExp

Index integer expression.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(map expression)

Type
AerospikeExp

<static> removeByIndexRange(ctx, idx, count, bin)

Create expression that removes "count" map items starting at specified index.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

idx AerospikeExp

Index integer expression.

count AerospikeExp

Count integer expression.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(map expression)

Type
AerospikeExp

<static> removeByIndexRangeToEnd(ctx, idx, bin)

Create expression that removes map items starting at specified index to the end of map.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

idx AerospikeExp

Index integer expression.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(map expression)

Type
AerospikeExp

<static> removeByKey(ctx, key, bin)

Create expression that removes map item identified by key.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

key AerospikeExp

Key expression.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(map expression)

Type
AerospikeExp

<static> removeByKeyList(ctx, keys, bin)

Create expression that removes map items identified by keys.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

keys AerospikeExp

List expression of keys to remove.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(map expression)

Type
AerospikeExp

<static> removeByKeyRange(ctx, begin, end, bin)

Create expression that removes map items identified by key range (begin inclusive, end exclusive). If begin is nil, the range is less than end. If end is infinity, the range is greater than equal to begin.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

begin AerospikeExp

Begin value expression.

end AerospikeExp

End value expression.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(map expression)

Type
AerospikeExp

<static> removeByKeyRelIndexRange(ctx, key, idx, count, bin)

Create expression that removes map items nearest to key and greater by index with a count limit.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

key AerospikeExp

Key expression.

idx AerospikeExp

Index integer expression.

count AerospikeExp

Count integer expression.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(map expression)

Type
AerospikeExp

<static> removeByKeyRelIndexRangeToEnd(ctx, key, idx, bin)

Create expression that removes map items nearest to key and greater by index.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

key AerospikeExp

Key expression.

idx AerospikeExp

Index integer expression.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(map expression)

Type
AerospikeExp

<static> removeByRank(ctx, rank, bin)

Create expression that removes map item identified by rank.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

rank AerospikeExp

Rank integer expression.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(map expression)

Type
AerospikeExp

<static> removeByRankRange(ctx, rank, count, bin)

Create expression that removes "count" map items starting at specified rank.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

rank AerospikeExp

Rank integer expression.

count AerospikeExp

Count integer expression.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(map expression)

Type
AerospikeExp

<static> removeByRankRangeToEnd(ctx, rank, bin)

Create expression that removes map items starting at specified rank to the last ranked item.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

rank AerospikeExp

Rank integer expression.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(map expression)

Type
AerospikeExp

<static> removeByValue(ctx, value, bin)

Create expression that removes map items identified by value.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

value AerospikeExp

Value expression.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(map expression)

Type
AerospikeExp

<static> removeByValueList(ctx, values, bin)

Create expression that removes map items identified by values.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

values AerospikeExp

Values list expression.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(map expression)

Type
AerospikeExp

<static> removeByValueRange(ctx, begin, end, bin)

Create expression that removes map items identified by value range (begin inclusive, end exclusive). If begin is nil, the range is less than end. If end is infinity, the range is greater than equal to begin.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

begin AerospikeExp

Begin value expression.

end AerospikeExp

End value expression.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(map expression)

Type
AerospikeExp

<static> removeByValueRelRankRange(ctx, value, rank, count, bin)

Create expression that removes map items nearest to value and greater by relative rank with a count limit.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

value AerospikeExp

Value expression.

rank AerospikeExp

Rank integer expression.

count AerospikeExp

Count integer expression.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(map expression)

Type
AerospikeExp

<static> removeByValueRelRankRangeToEnd(ctx, value, rank, bin)

Create expression that removes map items nearest to value and greater by relative rank.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

value AerospikeExp

Value expression.

rank AerospikeExp

Rank integer expression.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(map expression)

Type
AerospikeExp

<static> size(ctx, bin)

Create expression that returns map size.

Parameters:
Name Type Description
ctx AerospikeExp

Optional context path for nested CDT.

bin AerospikeExp

Map bin or map value expression.

Source:
Returns:

(integer expression)

Type
AerospikeExp