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 paramter error will be returned. If a range is partially out of bounds, the valid part of the range will be returned.

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.
get	Create list get operation. Server returns the item at the specified index in the list bin.
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_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.
size	Create list size operation. Server returns size of the list.
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.