ListOperation Methods

Aerospike

The ListOperation type exposes the following members.

Methods

  NameDescription
Public methodStatic memberAppend(String, Value, CTX)
Create default list append operation. Server appends value to end of list bin. Server returns list size.
Public methodStatic memberAppend(ListPolicy, String, Value, CTX)
Create list append operation with policy. Server appends value to list bin. Server returns list size.
Public methodStatic memberAppendItems(String, IList, CTX)
Create default list append items operation. Server appends each input list item to end of list bin. Server returns list size.
Public methodStatic memberAppendItems(ListPolicy, String, IList, CTX)
Create list append items operation with policy. Server appends each input list item to list bin. Server returns list size.
Public methodStatic memberClear
Create list clear operation. Server removes all items in list bin. Server does not return a result by default.
Public methodStatic memberCreate
Create list create operation. Server creates list at given context level. The context is allowed to be beyond list boundaries only if pad is set to true. In that case, nil list entries will be inserted to satisfy the context position.
Public methodStatic memberGet
Create list get operation. Server returns item at specified index in list bin.
Public methodStatic memberGetByIndex
Create list get by index operation. Server selects list item identified by index and returns selected data specified by returnType .
Public methodStatic memberGetByIndexRange(String, Int32, ListReturnType, CTX)
Create list get by index range operation. Server selects list items starting at specified index to the end of list and returns selected data specified by returnType.
Public methodStatic memberGetByIndexRange(String, Int32, Int32, ListReturnType, CTX)
Create list get by index range operation. Server selects "count" list items starting at specified index and returns selected data specified by returnType.
Public methodStatic memberGetByRank
Create list get by rank operation. Server selects list item identified by rank and returns selected data specified by returnType.
Public methodStatic memberGetByRankRange(String, Int32, ListReturnType, CTX)
Create list get by rank range operation. Server selects list items starting at specified rank to the last ranked item and returns selected data specified by returnType.
Public methodStatic memberGetByRankRange(String, Int32, Int32, ListReturnType, CTX)
Create list get by rank range operation. Server selects "count" list items starting at specified rank and returns selected data specified by returnType.
Public methodStatic memberGetByValue
Create list get by value operation. Server selects list items identified by value and returns selected data specified by returnType.
Public methodStatic memberGetByValueList
Create list get by value list operation. Server selects list items identified by values and returns selected data specified by returnType.
Public methodStatic memberGetByValueRange
Create list get by value range operation. Server selects 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.

Server returns selected data specified by returnType.

Public methodStatic memberGetByValueRelativeRankRange(String, Value, Int32, ListReturnType, CTX)
Create list get by value relative to rank range operation. Server selects list items nearest to value and greater by relative rank. Server 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]

Public methodStatic memberGetByValueRelativeRankRange(String, Value, Int32, Int32, ListReturnType, CTX)
Create list get by value relative to rank range operation. Server selects list items nearest to value and greater by relative rank with a count limit. Server 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) = []

Public methodStatic memberGetRange(String, Int32, CTX)
Create list get range operation. Server returns items starting at index to the end of list.
Public methodStatic memberGetRange(String, Int32, Int32, CTX)
Create list get range operation. Server returns "count" items starting at specified index in list bin.
Public methodStatic memberIncrement(String, Int32, CTX)
Create default list increment operation. Server increments list[index] by 1. Server returns list[index] after incrementing.
Public methodStatic memberIncrement(ListPolicy, String, Int32, CTX)
Create list increment operation with policy. Server increments list[index] by 1. Server returns list[index] after incrementing.
Public methodStatic memberIncrement(String, Int32, Value, CTX)
Create default list increment operation. Server increments list[index] by value. Value should be integer(IntegerValue, LongValue) or double(DoubleValue, FloatValue). Server returns list[index] after incrementing.
Public methodStatic memberIncrement(ListPolicy, String, Int32, Value, CTX)
Create list increment operation. Server increments list[index] by value. Value should be integer(IntegerValue, LongValue) or double(DoubleValue, FloatValue). Server returns list[index] after incrementing.
Public methodStatic memberInsert(String, Int32, Value, CTX)
Create default list insert operation. Server inserts value to specified index of list bin. Server returns list size.
Public methodStatic memberInsert(ListPolicy, String, Int32, Value, CTX)
Create list insert operation with policy. Server inserts value to specified index of list bin. Server returns list size.
Public methodStatic memberInsertItems(String, Int32, IList, CTX)
Create default list insert items operation. Server inserts each input list item starting at specified index of list bin. Server returns list size.
Public methodStatic memberInsertItems(ListPolicy, String, Int32, IList, CTX)
Create list insert items operation with policy. Server inserts each input list item starting at specified index of list bin. Server returns list size.
Public methodStatic memberPop
Create list pop operation. Server returns item at specified index and removes item from list bin.
Public methodStatic memberPopRange(String, Int32, CTX)
Create list pop range operation. Server returns items starting at specified index to the end of list and removes those items from list bin.
Public methodStatic memberPopRange(String, Int32, Int32, CTX)
Create list pop range operation. Server returns "count" items starting at specified index and removes items from list bin.
Public methodStatic memberRemove
Create list remove operation. Server removes item at specified index from list bin. Server returns number of items removed.
Public methodStatic memberRemoveByIndex
Create list remove operation. Server removes list item identified by index and returns removed data specified by returnType.
Public methodStatic memberRemoveByIndexRange(String, Int32, ListReturnType, CTX)
Create list remove operation. Server removes list items starting at specified index to the end of list and returns removed data specified by returnType.
Public methodStatic memberRemoveByIndexRange(String, Int32, Int32, ListReturnType, CTX)
Create list remove operation. Server removes "count" list items starting at specified index and returns removed data specified by returnType.
Public methodStatic memberRemoveByRank
Create list remove operation. Server removes list item identified by rank and returns removed data specified by returnType.
Public methodStatic memberRemoveByRankRange(String, Int32, ListReturnType, CTX)
Create list remove operation. Server removes list items starting at specified rank to the last ranked item and returns removed data specified by returnType.
Public methodStatic memberRemoveByRankRange(String, Int32, Int32, ListReturnType, CTX)
Create list remove operation. Server removes "count" list items starting at specified rank and returns removed data specified by returnType.
Public methodStatic memberRemoveByValue
Create list remove operation. Server removes list items identified by value and returns removed data specified by returnType.
Public methodStatic memberRemoveByValueList
Create list remove operation. Server removes list items identified by values and returns removed data specified by returnType.
Public methodStatic memberRemoveByValueRange
Create list remove operation. Server 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.

Server returns removed data specified by returnType.

Public methodStatic memberRemoveByValueRelativeRankRange(String, Value, Int32, ListReturnType, CTX)
Create list remove by value relative to rank range operation. Server removes list items nearest to value and greater by relative rank. Server returns removed data specified by returnType.

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]

Public methodStatic memberRemoveByValueRelativeRankRange(String, Value, Int32, Int32, ListReturnType, CTX)
Create list remove by value relative to rank range operation. Server removes list items nearest to value and greater by relative rank with a count limit. Server returns removed data specified by returnType.

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) = []

Public methodStatic memberRemoveRange(String, Int32, CTX)
Create list remove range operation. Server removes items starting at specified index to the end of list. Server returns number of items removed.
Public methodStatic memberRemoveRange(String, Int32, Int32, CTX)
Create list remove range operation. Server removes "count" items starting at specified index from list bin. Server returns number of items removed.
Public methodStatic memberSet(String, Int32, Value, CTX)
Create list set operation. Server sets item value at specified index in list bin. Server does not return a result by default.
Public methodStatic memberSet(ListPolicy, String, Int32, Value, CTX)
Create list set operation with policy. Server sets item value at specified index in list bin. Server does not return a result by default.
Public methodStatic memberSetOrder
Create set list order operation. Server sets list order. Server returns null.
Public methodStatic memberSize
Create list size operation. Server returns size of list.
Public methodStatic memberSort
Create list sort operation. Server sorts list according to sortFlags. Server does not return a result by default.
Public methodStatic memberTrim
Create list trim operation. Server removes items in list bin that do not fall into range specified by index and count range. If the range is out of bounds, then all items will be removed. Server returns list size after trim.
Top
See Also

Reference