The aerospike/exp/lists
module defines functions
for expressions on the List datatype.
- Source:
Methods
-
<static> append(ctx, policy, value, bin)
-
Create expression that appends value to end of list.
Parameters:
Name Type Description ctx
AerospikeExp Optional context path for nested CDT.
policy
Object Optional list write policy.
value
AerospikeExp Value expression.
bin
AerospikeExp List bin or list value expression.
- Source:
Returns:
(list expression)
- Type
- AerospikeExp
-
<static> appendItems(ctx, policy, value, bin)
-
Create expression that appends list items to end of list.
Parameters:
Name Type Description ctx
AerospikeExp Optional context path for nested CDT.
policy
Object Optional list write policy.
value
AerospikeExp List items expression.
bin
AerospikeExp List bin or list value expression.
- Source:
Returns:
(list expression)
- Type
- AerospikeExp
-
<static> clear(ctx, bin)
-
Create expression that removes all items in list.
Parameters:
Name Type Description ctx
AerospikeExp Optional context path for nested CDT.
bin
AerospikeExp List bin or list value expression.
- Source:
Returns:
(list expression)
- Type
- AerospikeExp
-
<static> getByIndex(ctx, returnType, valueType, idx, bin)
-
Create expression that selects list 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 List bin or list value expression.
- Source:
Returns:
(valueType expression)
- Type
- AerospikeExp
-
<static> getByIndexRange(ctx, returnType, idx, count, bin)
-
Create expression that selects "count" list 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 List bin or list value expression.
- Source:
Returns:
(expression)
- Type
- AerospikeExp
-
<static> getByIndexRangeToEnd(ctx, returnType, idx, bin)
-
Create expression that selects list items starting at specified index to the end of list 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 List bin or list value expression.
- Source:
Returns:
(expression)
- Type
- AerospikeExp
-
<static> getByRank(ctx, returnType, valueType, rank, bin)
-
Create expression that selects list 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 List bin or list value expression.
- Source:
Returns:
(valueType expression)
- Type
- AerospikeExp
-
<static> getByRankRange(ctx, returnType, rank, count, bin)
-
Create expression that selects "count" list 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 List bin or list value expression.
- Source:
Returns:
(expression)
- Type
- AerospikeExp
-
<static> getByRankRangeToEnd(ctx, returnType, rank, bin)
-
Create expression that selects list 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 List bin or list value expression.
- Source:
Returns:
(expression)
- Type
- AerospikeExp
-
<static> getByRelRankRange(ctx, returnType, value, rank, count, bin)
-
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.
Parameters:
Name Type Description ctx
AerospikeExp Optional context path for nested CDT.
returnType
AerospikeExp Return type.
value
AerospikeExp Values list expression.
rank
AerospikeExp Rank integer expression.
count
AerospikeExp Count integer expression.
bin
AerospikeExp List bin or list value expression.
- Source:
Returns:
(expression)
- Type
- AerospikeExp
-
<static> getByRelRankRangeToEnd(ctx, returnType, value, rank, bin)
-
Create expression that selects list items nearest to value and greater by relative rank 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 Values list expression.
rank
AerospikeExp Rank integer expression.
bin
AerospikeExp List bin or list value expression.
- Source:
Returns:
(expression)
- Type
- AerospikeExp
-
<static> getByValue(ctx, returnType, value, bin)
-
Create expression that selects list items identified by value and returns selected data specified by returnType.
Parameters:
Name Type Description ctx
Object Optional context path for nested CDT.
returnType
AerospikeExp Return type.
value
AerospikeExp Value expression.
bin
AerospikeExp List bin or list value expression.
- Source:
Returns:
(expression)
- Type
- AerospikeExp
-
<static> getByValueList(ctx, returnType, value, bin)
-
Create expression that selects list 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.
value
AerospikeExp Values list expression.
bin
AerospikeExp List bin or list value expression.
- Source:
Returns:
(expression)
- Type
- AerospikeExp
-
<static> getByValueRange(ctx, returnType, begin, end, bin)
-
Create expression that selects list items identified by value range and returns selected data specified by returnType.
Parameters:
Name Type Description ctx
Object Optional context path for nested CDT.
returnType
AerospikeExp Return type.
begin
AerospikeExp Begin value expression.
end
AerospikeExp End value expression.
bin
AerospikeExp List bin or list value expression.
- Source:
Returns:
(expression)
- Type
- AerospikeExp
-
<static> increment(ctx, policy, idx, value, bin)
-
Create expression that increments list[index] by value.
Parameters:
Name Type Description ctx
AerospikeExp Optional context path for nested CDT.
policy
Object Optional list write policy.
idx
AerospikeExp Index integer expression.
value
AerospikeExp Value expression.
bin
AerospikeExp List bin or list value expression.
- Source:
Returns:
(list expression)
- Type
- AerospikeExp
-
<static> insert(ctx, policy, idx, value, bin)
-
Create expression that inserts value to specified index of list.
Parameters:
Name Type Description ctx
AerospikeExp Optional context path for nested CDT.
policy
Object Optional list write policy.
idx
AerospikeExp Index integer expression.
value
AerospikeExp Value expression.
bin
AerospikeExp List bin or list value expression.
- Source:
Returns:
(list expression)
- Type
- AerospikeExp
-
<static> insertItems(ctx, policy, idx, value, bin)
-
Create expression that inserts each input list item starting at specified index of list.
Parameters:
Name Type Description ctx
AerospikeExp Optional context path for nested CDT.
policy
Object Optional list write policy.
idx
AerospikeExp Index integer expression.
value
AerospikeExp List items expression.
bin
AerospikeExp List bin or list value expression.
- Source:
Returns:
(list expression)
- Type
- AerospikeExp
-
<static> removeByIndex(ctx, idx, bin)
-
Create expression that removes list item identified by index.
Parameters:
Name Type Description ctx
AerospikeExp Optional context path for nested CDT.
idx
AerospikeExp Index integer expression.
bin
AerospikeExp List bin or list value expression.
- Source:
Returns:
(list expression)
- Type
- AerospikeExp
-
<static> removeByIndexRange(ctx, idx, count, bin)
-
Create expression that removes "count" list 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 List bin or list value expression.
- Source:
Returns:
(list expression)
- Type
- AerospikeExp
-
<static> removeByIndexRangeToEnd(ctx, idx, bin)
-
Create expression that removes list items starting at specified index to the end of list.
Parameters:
Name Type Description ctx
AerospikeExp Optional context path for nested CDT.
idx
AerospikeExp Index integer expression.
bin
AerospikeExp List bin or list value expression.
- Source:
Returns:
(list expression)
- Type
- AerospikeExp
-
<static> removeByRank(ctx, rank, bin)
-
Create expression that removes list item identified by rank.
Parameters:
Name Type Description ctx
AerospikeExp Optional context path for nested CDT.
rank
AerospikeExp Rank integer expression.
bin
AerospikeExp List bin or list value expression.
- Source:
Returns:
(list expression)
- Type
- AerospikeExp
-
<static> removeByRankRange(ctx, rank, count, bin)
-
Create expression that removes "count" list 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 List bin or list value expression.
- Source:
Returns:
(list expression)
- Type
- AerospikeExp
-
<static> removeByRankRangeToEnd(ctx, rank, bin)
-
Create expression that removes list 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 List bin or list value expression.
- Source:
Returns:
(list expression)
- Type
- AerospikeExp
-
<static> removeByRelRankRange(ctx, value, rank, count, bin)
-
Create expression that removes list 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 List bin or list value expression.
- Source:
Returns:
(list expression)
- Type
- AerospikeExp
-
<static> removeByRelRankRangeToEnd(ctx, value, rank, bin)
-
Create expression that removes list 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 List bin or list value expression.
- Source:
Returns:
(list expression)
- Type
- AerospikeExp
-
<static> removeByValue(ctx, value, bin)
-
Create expression that removes list items identified by value.
Parameters:
Name Type Description ctx
AerospikeExp Optional context path for nested CDT.
value
AerospikeExp Value expression.
bin
AerospikeExp List bin or list value expression.
- Source:
Returns:
(list expression)
- Type
- AerospikeExp
-
<static> removeByValueList(ctx, values, bin)
-
Create expression that removes list items identified by values.
Parameters:
Name Type Description ctx
AerospikeExp Optional context path for nested CDT.
values
AerospikeExp Values list expression.
bin
AerospikeExp List bin or list value expression.
- Source:
Returns:
(list expression)
- Type
- AerospikeExp
-
<static> removeByValueRange(ctx, begin, end, bin)
-
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.
Parameters:
Name Type Description ctx
AerospikeExp Optional context path for nested CDT.
begin
AerospikeExp Begin value expression.
end
AerospikeExp End value expression.
bin
AerospikeExp List bin or list value expression.
- Source:
Returns:
(list expression)
- Type
- AerospikeExp
-
<static> set(ctx, policy, idx, value, bin)
-
Create expression that sets item value at specified index in list.
Parameters:
Name Type Description ctx
AerospikeExp Optional context path for nested CDT.
policy
Object Optional list write policy.
idx
AerospikeExp Index integer expression.
value
AerospikeExp Value expression.
bin
AerospikeExp List bin or list value expression.
- Source:
Returns:
(list expression)
- Type
- AerospikeExp
-
<static> size(ctx, bin)
-
Create expression that returns list size.
Parameters:
Name Type Description ctx
Object Optional context path for nested CDT.
bin
AerospikeExp List bin or list value expression.
- Source:
Returns:
(integer expression)
- Type
- AerospikeExp
-
<static> sort(ctx, order, bin)
-
Create expression that sorts list.
Parameters:
Name Type Description ctx
AerospikeExp Optional context path for nested CDT.
order
number Sort order flags.
bin
AerospikeExp List bin or list value expression.
- Source:
Returns:
(list expression)
- Type
- AerospikeExp