Module aerospike::operations::maps
[−]
[src]
Unique key map bin operations. Create map operations used by the client's operate()
method.
All maps maintain an index and a rank. The index is the item offset from the start of the map, for both unordered and ordered maps. The rank is the sorted index of the value component. Map supports negative indexing for indexjkj and rank.
The default unique key map is unordered.
Index/Count examples:
- Index 0: First item in map.
- Index 4: Fifth item in map.
- Index -1: Last item in map.
- Index -3: Third to last item in map.
- Index 1, Count 2: Second and third items in map.
- Index -3, Count 3: Last three items in map.
- Index -5, Count 4: Range between fifth to last item to second to last item inclusive.
Rank examples:
- Rank 0: Item with lowest value rank in map.
- Rank 4: Fifth lowest ranked item in map.
- Rank -1: Item with highest ranked value in map.
- Rank -3: Item with third highest ranked value in map.
- Rank 1 Count 2: Second and third lowest ranked items in map.
- Rank -3 Count 3: Top three ranked items in map.
Structs
MapPolicy |
|
Enums
MapOrder |
Map storage order. |
MapReturnType |
Map return type. Type of data to return when selecting or removing items from the map. |
MapWriteMode |
Unique key map write type. |
Functions
clear |
Create map clear operation. Server removes all items in the map. Server does not return a result. |
decrement_value |
Create map decrement operation. Server decrements values by |
get_by_index |
Create map get by index operation. Server selects the map item identified by index and
returns the selected data specified by |
get_by_index_range |
Create map get by index range operation. Server selects |
get_by_index_range_from |
Create map get by index range operation. Server selects the map items starting at the
specified index to the end of the map and returns the selected data specified by
|
get_by_key |
Create map get by key operation. Server selects the map item idenfieid by the key and
returns the selected data specified by |
get_by_key_range |
Create map get by key range operation. Server selects the map items identified by the key
range ( |
get_by_rank |
Create map get by rank operation. Server selects the mamp item identified by rank and
returns the selected data specified by |
get_by_rank_range |
Create map get ranke range operation. Server selects |
get_by_rank_range_from |
Create map get by rank range operation. Server selects the map items starting at the
specified rank to the last ranked item and returns the selected data specified by
|
get_by_value |
Create map get by value operation. Server selects the map items identified by value and
returns the selected data specified by |
get_by_value_range |
Create map get by value range operation. Server selects the map items identified by the
value range ( |
increment_value |
Create map increment operation. Server increments values by |
put_item |
Create map put operation. Server writes the key/value item to the map bin and returns the map size. |
put_items |
Create map put items operation. Server writes each map item to the map bin and returns the map size. |
remove_by_index |
Create map remove operation. Server removes the map item identified by the index and return
the removed data specified by |
remove_by_index_range |
Create map remove operation. Server removes |
remove_by_index_range_from |
Create map remove operation. Server removes the map items starting at the specified index
to the end of the map and returns the removed data specified by |
remove_by_key |
Create map remove operation. Server removes the map item identified by the key and returns
the removed data specified by |
remove_by_key_list |
Create map remove operation. Server removes map items identified by keys and returns
removed data specified by |
remove_by_key_range |
Create map remove operation. Server removes map items identified by the key range
( |
remove_by_rank |
Create map remove operation. Server removes the map item identified by rank and returns the
removed data specified by |
remove_by_rank_range |
Create map remove operation. Server removes |
remove_by_rank_range_from |
Create map remove operation. Server removes the map items starting at the specified rank to
the last ranked item and returns the removed data specified by |
remove_by_value |
Create map remove operation. Server removes the map items identified by value and returns
the removed data specified by |
remove_by_value_list |
Create map remove operation. Server removes the map items identified by values and returns
the removed data specified by |
remove_by_value_range |
Create map remove operation. Server removes map items identified by value range ( |
set_order |
Create set map policy operation. Server set the map policy attributes. Server does not return a result. |
size |
Create map size operation. Server returns the size of the map. |