﻿ListExp Methods

# ListExp Methods

Aerospike

The ListExp type exposes the following members.

Methods

NameDescription
Append
Create expression that appends list items to end of list.
AppendItems
Create expression that appends list items to end of list.
Clear
Create expression that removes all items in list.
GetByIndex
Create expression that selects list item identified by index and returns selected data specified by returnType.
GetByIndexRange(ListReturnType, Exp, Exp, CTX)
Create expression that selects list items starting at specified index to the end of list and returns selected data specified by returnType.
GetByIndexRange(ListReturnType, Exp, Exp, Exp, CTX)
Create expression that selects "count" list items starting at specified index and returns selected data specified by returnType.
GetByRank
Create expression that selects list item identified by rank and returns selected data specified by returnType.
GetByRankRange(ListReturnType, Exp, Exp, CTX)
Create expression that selects list items starting at specified rank to the last ranked item and returns selected data specified by returnType.
GetByRankRange(ListReturnType, Exp, Exp, Exp, CTX)
Create expression that selects "count" list items starting at specified rank and returns selected data specified by returnType.
GetByValue
Create expression that selects list items identified by value and returns selected data specified by returnType.
GetByValueList
Create expression that selects list items identified by values and returns selected data specified by returnType.
GetByValueRange
Create expression that selects list items identified by value range and returns selected data specified by returnType.
GetByValueRelativeRankRange(ListReturnType, Exp, Exp, Exp, CTX)
Create expression that selects list items nearest to value and greater by relative rank and returns selected data specified by returnType.

Examples for ordered list [0,4,5,9,11,15]:

• (value,rank) = [selected items]
• (5,0) = [5,9,11,15]
• (5,1) = [9,11,15]
• (5,-1) = [4,5,9,11,15]
• (3,0) = [4,5,9,11,15]
• (3,3) = [11,15]
• (3,-3) = [0,4,5,9,11,15]

GetByValueRelativeRankRange(ListReturnType, Exp, Exp, Exp, Exp, CTX)
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.

Examples for ordered list [0,4,5,9,11,15]:

• (value,rank,count) = [selected items]
• (5,0,2) = [5,9]
• (5,1,1) = [9]
• (5,-1,2) = [4,5]
• (3,0,1) = [4]
• (3,3,7) = [11,15]
• (3,-3,2) = []

Increment
Create expression that increments list[index] by value. Value expression should resolve to a number.
Insert
Create expression that inserts value to specified index of list.
InsertItems
Create expression that inserts each input list item starting at specified index of list.
RemoveByIndex
Create expression that removes list item identified by index.
RemoveByIndexRange(Exp, Exp, CTX)
Create expression that removes list items starting at specified index to the end of list.
RemoveByIndexRange(Exp, Exp, Exp, CTX)
Create expression that removes "count" list items starting at specified index.
RemoveByRank
Create expression that removes list item identified by rank.
RemoveByRankRange(Exp, Exp, CTX)
Create expression that removes list items starting at specified rank to the last ranked item.
RemoveByRankRange(Exp, Exp, Exp, CTX)
Create expression that removes "count" list items starting at specified rank.
RemoveByValue
Create expression that removes list items identified by value.
RemoveByValueList
Create expression that removes list items identified by values.
RemoveByValueRange
Create expression that removes list 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 list items nearest to value and greater by relative rank.

Examples for ordered list [0,4,5,9,11,15]:

• (value,rank) = [removed items]
• (5,0) = [5,9,11,15]
• (5,1) = [9,11,15]
• (5,-1) = [4,5,9,11,15]
• (3,0) = [4,5,9,11,15]
• (3,3) = [11,15]
• (3,-3) = [0,4,5,9,11,15]

RemoveByValueRelativeRankRange(Exp, Exp, Exp, Exp, CTX)
Create expression that removes list items nearest to value and greater by relative rank with a count limit.

Examples for ordered list [0,4,5,9,11,15]:

• (value,rank,count) = [removed items]
• (5,0,2) = [5,9]
• (5,1,1) = [9]
• (5,-1,2) = [4,5]
• (3,0,1) = [4]
• (3,3,7) = [11,15]
• (3,-3,2) = []

Set
Create expression that sets item value at specified index in list.
Size
Create expression that returns list size.
Sort
Create expression that sorts list according to sortFlags.
Top
See Also