Map CDT operations for Aerospike.operate/4.
These builders create server-side map operations. Pass ctx: for nested CDT
paths and return_type: for selector operations that can return keys,
values, key/value pairs, counts, ranks, indexes, or existence flags.
Summary
Types
Common map operation options.
Map order attribute.
Map write policy accepted in opts[:policy].
Raw compatibility value for server integer policy constants.
Map selector return type.
Opaque map CDT operation for Aerospike.operate/4.
Map write policy flag or flags.
Functions
Removes all entries from the map.
Creates a map at the selected context level.
Decrements the numeric value at map_key and returns the final value.
Returns the entry at index, selected by return_type:.
Returns count entries from index, selected by return_type:.
Returns entries from index through the end, selected by return_type:.
Returns the entry for map_key, selected by return_type:.
Returns entries matching any key in keys, selected by return_type:.
Returns entries with keys in [begin_key, end_key), selected by return_type:.
Returns entries nearest to map_key and greater by relative index.
Returns count entries nearest to map_key and greater by relative index.
Returns the entry at rank, selected by return_type:.
Returns count entries from rank, selected by return_type:.
Returns entries from rank through the highest rank, selected by return_type:.
Returns entries equal to value, selected by return_type:.
Returns entries matching any value in values, selected by return_type:.
Returns entries with values in [begin_value, end_value), selected by return_type:.
Returns entries nearest to value and greater by relative rank.
Returns count entries nearest to value and greater by relative rank.
Increments the numeric value at map_key and returns the final value.
Create maps ordered by key.
Create maps ordered by key and value.
Create unordered maps by default.
Writes one key/value pair and returns the map size.
Writes multiple key/value pairs and returns the map size.
Removes the entry at index, returning data selected by return_type:.
Removes count entries from index, returning selected data.
Removes entries from index through the end, returning selected data.
Removes the entry for map_key, returning data selected by return_type:.
Removes entries matching any key in keys, returning selected data.
Removes entries with keys in [begin_key, end_key), returning selected data.
Removes entries nearest to map_key and greater by relative index.
Removes count entries nearest to map_key and greater by relative index.
Removes the entry at rank, returning data selected by return_type:.
Removes count entries from rank, returning selected data.
Removes entries from rank through the highest rank, returning selected data.
Removes entries equal to value, returning data selected by return_type:.
Removes entries matching any value in values, returning selected data.
Removes entries with values in [begin_value, end_value), returning selected data.
Removes entries nearest to value and greater by relative rank.
Removes count entries nearest to value and greater by relative rank.
Return the selected item count.
Return whether matching entries exist.
Return selected item indexes.
Invert the selector so it applies outside the matched range.
Return selected keys.
Return selected key/value pairs.
Return no result for a selector operation.
Return selected entries as an ordered map.
Return selected value ranks.
Return selected reverse indexes, counted from the map end.
Return selected reverse ranks, counted from the highest value.
Return selected entries as an unordered map.
Return selected values.
Sets the map order attributes.
Returns the number of entries in the map.
Only create map items that do not already exist.
Use default map write behavior.
Do not fail the command when a map item is rejected by write flags.
Commit valid map items even when another item is rejected by write flags.
Only update map items that already exist.
Types
@type opts() :: [ ctx: Aerospike.Ctx.t(), return_type: return_type(), policy: policy(), persist_index: boolean() ]
Common map operation options.
Supported keys:
:ctx- nested CDT context path fromAerospike.Ctx.:return_type- selector return type from thereturn_*helpers.:policy- map write policy for put/increment/decrement operations.:persist_index- persist the index for top-level ordered maps.
@type order() :: :unordered | :key_ordered | :key_value_ordered | raw_integer()
Map order attribute.
@type policy() :: %{ optional(:order) => order(), optional(:attr) => order(), optional(:flags) => write_flags() } | [order: order(), attr: order(), flags: write_flags()]
Map write policy accepted in opts[:policy].
Prefer :order for the map order. :attr remains accepted for
compatibility. Omitted keys default to 0.
@type raw_integer() :: non_neg_integer() | {:raw, non_neg_integer()}
Raw compatibility value for server integer policy constants.
@type return_type() :: :none | :index | :reverse_index | :rank | :reverse_rank | :count | :key | :value | :key_value | :exists | :unordered_map | :ordered_map | :inverted | [ :inverted | :index | :reverse_index | :rank | :reverse_rank | :count | :key | :value | :key_value | :exists | :unordered_map | :ordered_map ] | raw_integer()
Map selector return type.
@opaque t()
Opaque map CDT operation for Aerospike.operate/4.
@type write_flag() :: :default | :create_only | :update_only | :no_fail | :partial
Map write policy flag or flags.
@type write_flags() :: write_flag() | [write_flag()] | raw_integer()
Functions
Removes all entries from the map.
Creates a map at the selected context level.
When ctx: is omitted, this sets the top-level bin map order. Nested map
creation ignores persist_index: because server indexes are top-level only.
Decrements the numeric value at map_key and returns the final value.
Returns the entry at index, selected by return_type:.
Returns count entries from index, selected by return_type:.
Returns entries from index through the end, selected by return_type:.
Returns the entry for map_key, selected by return_type:.
Returns entries matching any key in keys, selected by return_type:.
Returns entries with keys in [begin_key, end_key), selected by return_type:.
Pass nil for an open range boundary.
Returns entries nearest to map_key and greater by relative index.
Returns count entries nearest to map_key and greater by relative index.
Returns the entry at rank, selected by return_type:.
Returns count entries from rank, selected by return_type:.
Returns entries from rank through the highest rank, selected by return_type:.
Returns entries equal to value, selected by return_type:.
Returns entries matching any value in values, selected by return_type:.
Returns entries with values in [begin_value, end_value), selected by return_type:.
Pass nil for an open range boundary.
Returns entries nearest to value and greater by relative rank.
Returns count entries nearest to value and greater by relative rank.
Increments the numeric value at map_key and returns the final value.
@spec order_key_ordered() :: 1
Create maps ordered by key.
@spec order_key_value_ordered() :: 3
Create maps ordered by key and value.
@spec order_unordered() :: 0
Create unordered maps by default.
Writes one key/value pair and returns the map size.
Pass policy: [order: order, flags: flags] to include map order attributes
and write flags in the operation payload.
Writes multiple key/value pairs and returns the map size.
Pass policy: [order: order, flags: flags] to include map order attributes
and write flags in the operation payload.
Removes the entry at index, returning data selected by return_type:.
Removes count entries from index, returning selected data.
Removes entries from index through the end, returning selected data.
Removes the entry for map_key, returning data selected by return_type:.
Removes entries matching any key in keys, returning selected data.
Removes entries with keys in [begin_key, end_key), returning selected data.
Pass nil for an open range boundary.
Removes entries nearest to map_key and greater by relative index.
@spec remove_by_key_rel_index_range_count( String.t(), term(), integer(), integer(), opts() ) :: t()
Removes count entries nearest to map_key and greater by relative index.
Removes the entry at rank, returning data selected by return_type:.
Removes count entries from rank, returning selected data.
Removes entries from rank through the highest rank, returning selected data.
Removes entries equal to value, returning data selected by return_type:.
Removes entries matching any value in values, returning selected data.
Removes entries with values in [begin_value, end_value), returning selected data.
Pass nil for an open range boundary.
Removes entries nearest to value and greater by relative rank.
@spec remove_by_value_rel_rank_range_count( String.t(), term(), integer(), integer(), opts() ) :: t()
Removes count entries nearest to value and greater by relative rank.
@spec return_count() :: 5
Return the selected item count.
@spec return_exists() :: 13
Return whether matching entries exist.
@spec return_index() :: 1
Return selected item indexes.
@spec return_inverted() :: 65536
Invert the selector so it applies outside the matched range.
@spec return_key() :: 6
Return selected keys.
@spec return_key_value() :: 8
Return selected key/value pairs.
@spec return_none() :: 0
Return no result for a selector operation.
@spec return_ordered_map() :: 17
Return selected entries as an ordered map.
@spec return_rank() :: 3
Return selected value ranks.
@spec return_reverse_index() :: 2
Return selected reverse indexes, counted from the map end.
@spec return_reverse_rank() :: 4
Return selected reverse ranks, counted from the highest value.
@spec return_unordered_map() :: 16
Return selected entries as an unordered map.
@spec return_value() :: 7
Return selected values.
Sets the map order attributes.
Returns the number of entries in the map.
@spec write_create_only() :: 1
Only create map items that do not already exist.
@spec write_default() :: 0
Use default map write behavior.
@spec write_no_fail() :: 4
Do not fail the command when a map item is rejected by write flags.
@spec write_partial() :: 8
Commit valid map items even when another item is rejected by write flags.
@spec write_update_only() :: 2
Only update map items that already exist.