Module aerospike::operations::lists

List bin operations. Create list operations used by the client’s operate() method.

List operations support negative indexing. If the index is negative, the resolved index starts backwards from the end of the list.

Index/Count examples:

• Index 0: First item in list.
• Index 4: Fifth item in list.
• Index -1: Last item in list.
• Index -3: Third to last item in list.
• Index 1, Count 2: Second and third item in list.
• Index -3, Count 3: Last three items in list.
• Index -5, Count 4: Range between fifth to last item to second to last item inclusive.

If an index is out of bounds, a parameter error will be returned. If a range is partially out of bounds, the valid part of the range will be returned.

Structs

• ListPolicy
  ListPolicy directives when creating a list and writing list items.

Enums

• ListOrderType
  List storage order.
• ListReturnType
  CdtListReturnType determines the returned values in CDT List operations.
• ListSortFlags
  CdtListSortFlags determines sort flags for CDT lists
• ListWriteFlags
  CdtListWriteFlags determines write flags for CDT lists

Functions

• append
  Create list append operation. Server appends value to the end of list bin. Server returns list size.
• append_items
  Create list append items operation. Server appends each input list item to the end of list bin. Server returns list size.
• clear
  Create list clear operation. Server removes all items in the list bin. Server does not return a result by default.
• create
  Creates 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.
• get
  Create list get operation. Server returns the item at the specified index in the list bin.
• get_by_index
  Creates list get by index operation. Server selects list item identified by index and returns selected data specified by returnType
• get_by_index_range
  Creates 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.
• get_by_index_range_count
  Creates list get by index range operation. Server selects “count” list items starting at specified index and returns selected data specified by returnType.
• get_by_rank
  Creates a list get by rank operation. Server selects list item identified by rank and returns selected data specified by returnType.
• get_by_rank_range
  Creates a 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.
• get_by_rank_range_count
  Creates a list get by rank range operation. Server selects “count” list items starting at specified rank and returns selected data specified by returnType.
• get_by_value
  Creates a list get by value operation. Server selects list items identified by value and returns selected data specified by returnType.
• get_by_value_list
  Creates list get by value list operation. Server selects list items identified by values and returns selected data specified by returnType.
• get_by_value_range
  Creates a 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.
• get_by_value_relative_rank_range
  Creates a 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.
• get_by_value_relative_rank_range_count
  Creates a 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.
• get_range
  Create list get range operation. Server returns count items starting at the specified index in the list bin.
• get_range_from
  Create list get range operation. Server returns items starting at the index to the end of the list.
• increment
  Create list increment operation. Server increments the item value at the specified index by the given amount and returns the final result.
• insert
  Create list insert operation. Server inserts value to the specified index of the list bin. Server returns list size.
• insert_items
  Create list insert items operation. Server inserts each input list item starting at the specified index of the list bin. Server returns list size.
• pop
  Create list pop operation. Server returns the item at the specified index and removes the item from the list bin.
• pop_range
  Create list pop range operation. Server returns count items starting at the specified index and removes the items from the list bin.
• pop_range_from
  Create list pop range operation. Server returns the items starting at the specified index to the end of the list and removes those items from the list bin.
• remove
  Create list remove operation. Server removes the item at the specified index from the list bin. Server returns the number of items removed.
• remove_by_index
  Creates a list remove operation. Server removes list item identified by index and returns removed data specified by returnType.
• remove_by_index_range
  Creates a list remove operation. Server removes list items starting at specified index to the end of list and returns removed data specified by returnType.
• remove_by_index_range_count
  Creates a list remove operation. Server removes “count” list items starting at specified index and returns removed data specified by returnType.
• remove_by_rank
  Creates a list remove operation. Server removes list item identified by rank and returns removed data specified by returnType.
• remove_by_rank_range
  Creates a list remove operation. Server removes list items starting at specified rank to the last ranked item and returns removed data specified by returnType.
• remove_by_rank_range_count
  Creates a list remove operation. Server removes “count” list items starting at specified rank and returns removed data specified by returnType.
• remove_by_value
  Create list remove value operation. Server removes all items that are equal to the specified value. Server returns the number of items removed.
• remove_by_value_list
  Create list remove by value list operation. Server removes all items that are equal to one of the specified values. Server returns the number of items removed
• remove_by_value_range
  Creates a list remove operation. Server removes list items identified by value range (valueBegin inclusive, valueEnd exclusive). If valueBegin is nil, the range is less than valueEnd. If valueEnd is nil, the range is greater than equal to valueBegin. Server returns removed data specified by returnType
• remove_by_value_relative_rank_range
  Creates a 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.
• remove_by_value_relative_rank_range_count
  Creates a 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.
• remove_range
  Create list remove range operation. Server removes count items starting at the specified index from the list bin. Server returns the number of items removed.
• remove_range_from
  Create list remove range operation. Server removes the items starting at the specified index to the end of the list. Server returns the number of items removed.
• set
  Create list set operation. Server sets the item value at the specified index in the list bin. Server does not return a result by default.
• set_order
  Creates a set list order operation. Server sets list order. Server returns null.
• size
  Create list size operation. Server returns size of the list.
• sort
  Creates list sort operation. Server sorts list according to sortFlags. Server does not return a result by default.
• trim
  Create list trim operation. Server removes count items in the list bin that do not fall into the range specified by index and count. If the range is out of bounds, then all items will be removed. Server returns list size after trim.