aerospike/exp/maps

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

Description:
Source:

Methods

(static) clear(bin, ctx) → {AerospikeExp}

Description:

  • Create expression that removes all items in map.

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(map expression)

Type
AerospikeExp

(static) getByIndex(bin, idx, valueType, returnType, ctx) → {AerospikeExp}

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
idx AerospikeExp

Index integer expression.
valueType AerospikeExp

expression value type.
returnType AerospikeExp

Return type.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(expression)

Type
AerospikeExp

(static) getByIndexRange(bin, count, idx, returnType, ctx) → {AerospikeExp}

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
count AerospikeExp

Count integer expression.
idx AerospikeExp

Index integer expression.
returnType AerospikeExp

Return type.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(expression)

Type
AerospikeExp

(static) getByIndexRangeToEnd(bin, idx, returnType, ctx) → {AerospikeExp}

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
idx AerospikeExp

Index integer expression.
returnType AerospikeExp

Return type.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(expression)

Type
AerospikeExp

(static) getByKey(bin, key, valueType, returnType, ctx) → {AerospikeExp}

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
key AerospikeExp

Key expression.
valueType AerospikeExp

expression value type.
returnType AerospikeExp

Return type.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(expression)

Type
AerospikeExp

(static) getByKeyList(bin, keys, returnType, ctx) → {AerospikeExp}

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
keys AerospikeExp

Keys list expression.
returnType AerospikeExp

Return type.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(expression)

Type
AerospikeExp

(static) getByKeyRange(bin, end, begin, returnType, ctx) → {AerospikeExp}

Description:

  • 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.

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
end AerospikeExp

End key expression.
begin AerospikeExp

Begin key expression.
returnType AerospikeExp

Return type.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(expression)

Type
AerospikeExp

(static) getByKeyRelIndexRange(bin, count, idx, key, returnType, ctx) → {AerospikeExp}

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
count AerospikeExp

Count integer expression.
idx AerospikeExp

Index integer expression.
key AerospikeExp

Key expression.
returnType AerospikeExp

Return type.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(expression)

Type
AerospikeExp

(static) getByKeyRelIndexRangeToEnd(bin, idx, key, returnType, ctx) → {AerospikeExp}

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
idx AerospikeExp

Index integer expression.
key AerospikeExp

Key expression.
returnType AerospikeExp

Return type.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(expression)

Type
AerospikeExp

(static) getByRank(bin, rank, valueType, returnType, ctx) → {AerospikeExp}

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
rank AerospikeExp

Rank integer expression.
valueType AerospikeExp

expression value type.
returnType AerospikeExp

Return type.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(expression)

Type
AerospikeExp

(static) getByRankRange(bin, count, rank, returnType, ctx) → {AerospikeExp}

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
count AerospikeExp

Count integer expression.
rank AerospikeExp

Rank integer expression.
returnType AerospikeExp

Return type.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(expression)

Type
AerospikeExp

(static) getByRankRangeToEnd(bin, rank, returnType, ctx) → {AerospikeExp}

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
rank AerospikeExp

Rank integer expression.
returnType AerospikeExp

Return type.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(expression)

Type
AerospikeExp

(static) getByValue(bin, value, returnType, ctx) → {AerospikeExp}

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
value AerospikeExp

Value expression.
returnType AerospikeExp

Return type.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(expression)

Type
AerospikeExp

(static) getByValueList(bin, returnType, values, ctx) → {AerospikeExp}

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
returnType AerospikeExp

Return type.
values AerospikeExp

Values list expression.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(expression)

Type
AerospikeExp

(static) getByValueRange(bin, end, begin, returnType, ctx) → {AerospikeExp}

Description:

  • 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.

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
end AerospikeExp

End value expression.
begin AerospikeExp

Begin value expression.
returnType AerospikeExp

Return type.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(expression)

Type
AerospikeExp

(static) getByValueRelRankRange(bin, count, rank, value, returnType, ctx) → {AerospikeExp}

Description:

  • 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.

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
count AerospikeExp

Count integer expression.
rank AerospikeExp

Rank integer expression.
value AerospikeExp

Value expression.
returnType AerospikeExp

Return type.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(expression)

Type
AerospikeExp

(static) getByValueRelRankRangeToEnd(bin, rank, value, returnType, ctx) → {AerospikeExp}

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
rank AerospikeExp

Rank integer expression.
value AerospikeExp

Value expression.
returnType AerospikeExp

Return type.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(expression)

Type
AerospikeExp

(static) increment(bin, value, key, policy, ctx) → {AerospikeExp}

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
value AerospikeExp

Increment value number expression.
key AerospikeExp

Key expression.
policy Object

Optional map write policy.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(map expression)

Type
AerospikeExp

(static) put(bin, value, key, policy, ctx) → {AerospikeExp}

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
value AerospikeExp

Value expression.
key AerospikeExp

Key expression.
policy Object

Optional map write policy.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(map expression)

Type
AerospikeExp

(static) putItems(bin, map, policy, ctx) → {AerospikeExp}

Description:

  • Create expression that writes each map item to map bin.

Source:
Parameters:
Name Type Description
bin AerospikeExp

Target map bin or map value expression.
map AerospikeExp

Source map expression.
policy Object

Optional map write policy.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(map expression)

Type
AerospikeExp

(static) removeByIndex(bin, idx, ctx, returnType) → {AerospikeExp}

Description:

  • Create expression that removes map item identified by index.

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
idx AerospikeExp

Index integer expression.
ctx AerospikeExp

Optional context path for nested CDT.
returnType AerospikeExp

Optional Return type. Valid values are returnType.NONE or returnType.INVERTED.
Returns:

(map expression)

Type
AerospikeExp

(static) removeByIndexRange(bin, count, idx, ctx, returnType) → {AerospikeExp}

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
count AerospikeExp

Count integer expression.
idx AerospikeExp

Index integer expression.
ctx AerospikeExp

Optional context path for nested CDT.
returnType AerospikeExp

Optional Return type. Valid values are returnType.NONE or returnType.INVERTED.
Returns:

(map expression)

Type
AerospikeExp

(static) removeByIndexRangeToEnd(bin, idx, ctx, returnType) → {AerospikeExp}

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
idx AerospikeExp

Index integer expression.
ctx AerospikeExp

Optional context path for nested CDT.
returnType AerospikeExp

Optional Return type. Valid values are returnType.NONE or returnType.INVERTED.
Returns:

(map expression)

Type
AerospikeExp

(static) removeByKey(bin, key, ctx, returnType) → {AerospikeExp}

Description:

  • Create expression that removes map item identified by key.

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
key AerospikeExp

Key expression.
ctx AerospikeExp

Optional context path for nested CDT.
returnType AerospikeExp

Optional Return type. Valid values are returnType.NONE or returnType.INVERTED.
Returns:

(map expression)

Type
AerospikeExp

(static) removeByKeyList(bin, keys, ctx, returnType) → {AerospikeExp}

Description:

  • Create expression that removes map items identified by keys.

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
keys AerospikeExp

List expression of keys to remove.
ctx AerospikeExp

Optional context path for nested CDT.
returnType AerospikeExp

Optional Return type. Valid values are returnType.NONE or returnType.INVERTED.
Returns:

(map expression)

Type
AerospikeExp

(static) removeByKeyRange(bin, end, begin, ctx, returnType) → {AerospikeExp}

Description:

  • 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.

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
end AerospikeExp

End value expression.
begin AerospikeExp

Begin value expression.
ctx AerospikeExp

Optional context path for nested CDT.
returnType AerospikeExp

Optional Return type. Valid values are returnType.NONE or returnType.INVERTED.
Returns:

(map expression)

Type
AerospikeExp

(static) removeByKeyRelIndexRange(bin, count, idx, key, ctx, returnType) → {AerospikeExp}

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
count AerospikeExp

Count integer expression.
idx AerospikeExp

Index integer expression.
key AerospikeExp

Key expression.
ctx AerospikeExp

Optional context path for nested CDT.
returnType AerospikeExp

Optional Return type. Valid values are returnType.NONE or returnType.INVERTED.
Returns:

(map expression)

Type
AerospikeExp

(static) removeByKeyRelIndexRangeToEnd(bin, idx, key, ctx, returnType) → {AerospikeExp}

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
idx AerospikeExp

Index integer expression.
key AerospikeExp

Key expression.
ctx AerospikeExp

Optional context path for nested CDT.
returnType AerospikeExp

Optional Return type. Valid values are returnType.NONE or returnType.INVERTED.
Returns:

(map expression)

Type
AerospikeExp

(static) removeByRank(bin, rank, ctx, returnType) → {AerospikeExp}

Description:

  • Create expression that removes map item identified by rank.

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
rank AerospikeExp

Rank integer expression.
ctx AerospikeExp

Optional context path for nested CDT.
returnType AerospikeExp

Optional Return type. Valid values are returnType.NONE or returnType.INVERTED.
Returns:

(map expression)

Type
AerospikeExp

(static) removeByRankRange(bin, count, rank, ctx, returnType) → {AerospikeExp}

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
count AerospikeExp

Count integer expression.
rank AerospikeExp

Rank integer expression.
ctx AerospikeExp

Optional context path for nested CDT.
returnType AerospikeExp

Optional Return type. Valid values are returnType.NONE or returnType.INVERTED.
Returns:

(map expression)

Type
AerospikeExp

(static) removeByRankRangeToEnd(bin, rank, ctx, returnType) → {AerospikeExp}

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
rank AerospikeExp

Rank integer expression.
ctx AerospikeExp

Optional context path for nested CDT.
returnType AerospikeExp

Optional Return type. Valid values are returnType.NONE or returnType.INVERTED.
Returns:

(map expression)

Type
AerospikeExp

(static) removeByValue(bin, value, ctx, returnType) → {AerospikeExp}

Description:

  • Create expression that removes map items identified by value.

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
value AerospikeExp

Value expression.
ctx AerospikeExp

Optional context path for nested CDT.
returnType AerospikeExp

Optional Return type. Valid values are returnType.NONE or returnType.INVERTED.
Returns:

(map expression)

Type
AerospikeExp

(static) removeByValueList(bin, values, ctx, returnType) → {AerospikeExp}

Description:

  • Create expression that removes map items identified by values.

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
values AerospikeExp

Values list expression.
ctx AerospikeExp

Optional context path for nested CDT.
returnType AerospikeExp

Optional Return type. Valid values are returnType.NONE or returnType.INVERTED.
Returns:

(map expression)

Type
AerospikeExp

(static) removeByValueRange(bin, end, begin, ctx, returnType) → {AerospikeExp}

Description:

  • 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.

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
end AerospikeExp

End value expression.
begin AerospikeExp

Begin value expression.
ctx AerospikeExp

Optional context path for nested CDT.
returnType AerospikeExp

Optional Return type. Valid values are returnType.NONE or returnType.INVERTED.
Returns:

(map expression)

Type
AerospikeExp

(static) removeByValueRelRankRange(bin, count, rank, value, ctx, returnType) → {AerospikeExp}

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
count AerospikeExp

Count integer expression.
rank AerospikeExp

Rank integer expression.
value AerospikeExp

Value expression.
ctx AerospikeExp

Optional context path for nested CDT.
returnType AerospikeExp

Optional Return type. Valid values are returnType.NONE or returnType.INVERTED.
Returns:

(map expression)

Type
AerospikeExp

(static) removeByValueRelRankRangeToEnd(bin, rank, value, ctx, returnType) → {AerospikeExp}

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
rank AerospikeExp

Rank integer expression.
value AerospikeExp

Value expression.
ctx AerospikeExp

Optional context path for nested CDT.
returnType AerospikeExp

Optional Return type. Valid values are returnType.NONE or returnType.INVERTED.
Returns:

(map expression)

Type
AerospikeExp

(static) size(bin, ctx) → {AerospikeExp}

Description:

  • Create expression that returns map size.

Source:
Parameters:
Name Type Description
bin AerospikeExp

Map bin or map value expression.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(integer expression)

Type
AerospikeExp