aerospike/exp/lists

Description:
Source:

The aerospike/exp/lists module defines functions for expressions on the List datatype.

Methods

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

Description:

  • Create expression that appends value to end of list.

Source:
Parameters:
Name Type Description
bin AerospikeExp

List bin or list value expression.
value AerospikeExp

Value expression.
policy Object

Optional list write policy.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(list expression)

Type
AerospikeExp

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

Description:

  • Create expression that appends list items to end of list.

Source:
Parameters:
Name Type Description
bin AerospikeExp

List bin or list value expression.
value AerospikeExp

List items expression.
policy Object

Optional list write policy.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(list expression)

Type
AerospikeExp

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

Description:

  • Create expression that removes all items in list.

Source:
Parameters:
Name Type Description
bin AerospikeExp

List bin or list value expression.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(list expression)

Type
AerospikeExp

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

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

List bin or list 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:

(valueType expression)

Type
AerospikeExp

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

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

List bin or list 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 list items starting at specified index to the end of list and returns selected data specified by returnType.

Source:
Parameters:
Name Type Description
bin AerospikeExp

List bin or list value expression.
idx AerospikeExp

Index integer 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 list item identified by rank and returns selected data specified by returnType.

Source:
Parameters:
Name Type Description
bin AerospikeExp

List bin or list 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:

(valueType expression)

Type
AerospikeExp

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

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

List bin or list value expression.
rank AerospikeExp

Rank integer expression.
count AerospikeExp

Count 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 list items starting at specified rank to the last ranked item and returns selected data specified by returnType.

Source:
Parameters:
Name Type Description
bin AerospikeExp

List bin or list value expression.
rank AerospikeExp

Rank integer expression.
returnType AerospikeExp

Return type.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(expression)

Type
AerospikeExp

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

Description:

  • Create expression that selects list items nearest to value and greater by relative rank with a count limit and returns selected data specified by returnType.

Source:
Parameters:
Name Type Description
bin AerospikeExp

List bin or list value expression.
value AerospikeExp

Values list expression.
rank AerospikeExp

Rank integer expression.
count AerospikeExp

Count integer expression.
returnType AerospikeExp

Return type.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(expression)

Type
AerospikeExp

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

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

List bin or list value expression.
rank AerospikeExp

Rank integer expression.
value AerospikeExp

Values list 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 list items identified by value and returns selected data specified by returnType.

Source:
Parameters:
Name Type Description
bin AerospikeExp

List bin or list value expression.
value AerospikeExp

Value expression.
returnType AerospikeExp

Return type.
ctx Object

Optional context path for nested CDT.
Returns:

(expression)

Type
AerospikeExp

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

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

List bin or list value expression.
value AerospikeExp

Values list expression.
returnType AerospikeExp

Return type.
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 list items identified by value range and returns selected data specified by returnType.

Source:
Parameters:
Name Type Description
bin AerospikeExp

List bin or list value expression.
end AerospikeExp

End value expression.
begin AerospikeExp

Begin value expression.
returnType AerospikeExp

Return type.
ctx Object

Optional context path for nested CDT.
Returns:

(expression)

Type
AerospikeExp

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

Description:

  • Create expression that increments list[index] by value.

Source:
Parameters:
Name Type Description
bin AerospikeExp

List bin or list value expression.
value AerospikeExp

Value expression.
idx AerospikeExp

Index integer expression.
policy Object

Optional list write policy.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(list expression)

Type
AerospikeExp

(static) insert(bin, value, idx, policy, ctx) → {AerospikeExp}

Description:

  • Create expression that inserts value to specified index of list.

Source:
Parameters:
Name Type Description
bin AerospikeExp

List bin or list value expression.
value AerospikeExp

Value expression.
idx AerospikeExp

Index integer expression.
policy Object

Optional list write policy.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(list expression)

Type
AerospikeExp

(static) insertItems(bin, value, idx, policy, ctx) → {AerospikeExp}

Description:

  • Create expression that inserts each input list item starting at specified index of list.

Source:
Parameters:
Name Type Description
bin AerospikeExp

List bin or list value expression.
value AerospikeExp

List items expression.
idx AerospikeExp

Index integer expression.
policy Object

Optional list write policy.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(list expression)

Type
AerospikeExp

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

Description:

  • Create expression that removes list item identified by index.

Source:
Parameters:
Name Type Description
bin AerospikeExp

List bin or list value expression.
idx AerospikeExp

Index integer expression.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(list expression)

Type
AerospikeExp

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

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

List bin or list value expression.
count AerospikeExp

Count integer expression.
idx AerospikeExp

Index integer expression.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(list expression)

Type
AerospikeExp

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

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

List bin or list value expression.
idx AerospikeExp

Index integer expression.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(list expression)

Type
AerospikeExp

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

Description:

  • Create expression that removes list item identified by rank.

Source:
Parameters:
Name Type Description
bin AerospikeExp

List bin or list value expression.
rank AerospikeExp

Rank integer expression.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(list expression)

Type
AerospikeExp

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

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

List bin or list value expression.
count AerospikeExp

Count integer expression.
rank AerospikeExp

Rank integer expression.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(list expression)

Type
AerospikeExp

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

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

List bin or list value expression.
rank AerospikeExp

Rank integer expression.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(list expression)

Type
AerospikeExp

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

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

List bin or list value expression.
count AerospikeExp

Count integer expression.
rank AerospikeExp

Rank integer expression.
value AerospikeExp

Value expression.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(list expression)

Type
AerospikeExp

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

Description:

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

Source:
Parameters:
Name Type Description
bin AerospikeExp

List bin or list value expression.
rank AerospikeExp

Rank integer expression.
value AerospikeExp

Value expression.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(list expression)

Type
AerospikeExp

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

Description:

  • Create expression that removes list items identified by value.

Source:
Parameters:
Name Type Description
bin AerospikeExp

List bin or list value expression.
value AerospikeExp

Value expression.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(list expression)

Type
AerospikeExp

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

Description:

  • Create expression that removes list items identified by values.

Source:
Parameters:
Name Type Description
bin AerospikeExp

List bin or list value expression.
values AerospikeExp

Values list expression.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(list expression)

Type
AerospikeExp

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

Description:

  • Create expression that removes list 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

List bin or list value expression.
end AerospikeExp

End value expression.
begin AerospikeExp

Begin value expression.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(list expression)

Type
AerospikeExp

(static) set(bin, value, idx, policy, ctx) → {AerospikeExp}

Description:

  • Create expression that sets item value at specified index in list.

Source:
Parameters:
Name Type Description
bin AerospikeExp

List bin or list value expression.
value AerospikeExp

Value expression.
idx AerospikeExp

Index integer expression.
policy Object

Optional list write policy.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(list expression)

Type
AerospikeExp

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

Description:

  • Create expression that returns list size.

Source:
Parameters:
Name Type Description
bin AerospikeExp

List bin or list value expression.
ctx Object

Optional context path for nested CDT.
Returns:

(integer expression)

Type
AerospikeExp

(static) sort(bin, order, ctx) → {AerospikeExp}

Description:

  • Create expression that sorts list.

Source:
Parameters:
Name Type Description
bin AerospikeExp

List bin or list value expression.
order number

Sort order flags.
ctx AerospikeExp

Optional context path for nested CDT.
Returns:

(list expression)

Type
AerospikeExp