Context path steps for nested CDT operations.
Each helper returns one {context_id, value} pair that can be passed as
part of a ctx list to CDT helpers.
Summary
Types
List order used when a context step creates a nested list.
Map order used when a context step creates a nested map.
A single nested-CDT navigation step.
Nested CDT context path.
Functions
Navigate to every child of the current collection.
Navigate to children of the current collection that match expression.
Deserializes a Base64-encoded context path.
Deserializes MessagePack context bytes.
Navigate into a list by absolute index.
Navigate into a list by index, creating a nested list when it is missing.
Navigate into a list by rank.
Navigate to the list element equal to value.
Navigate into a map by entry index.
Navigate into the map entry for key.
Navigate into a map by key, creating a nested map when it is missing.
Navigate into a map by value rank.
Navigate to the map entry whose value equals value.
Serializes a context path to Base64-encoded MessagePack bytes.
Serializes a context path to MessagePack bytes.
Types
@type list_order() :: :unordered | :ordered
List order used when a context step creates a nested list.
:unordered creates a normal list. :ordered creates an ordered list.
@type map_order() :: :unordered | :key_ordered | :key_value_ordered
Map order used when a context step creates a nested map.
:unordered keeps no ordering, :key_ordered orders entries by key, and
:key_value_ordered orders by key and value.
@type step() :: {non_neg_integer(), term()}
A single nested-CDT navigation step.
@type t() :: [step()]
Nested CDT context path.
Pass this list as ctx: to CDT operation builders that support nested
collection access.
Functions
@spec all_children() :: step()
Navigate to every child of the current collection.
@spec all_children_with_filter(Aerospike.Exp.t()) :: step()
Navigate to children of the current collection that match expression.
The expression is evaluated with Aerospike's built-in loop variables, such as
Aerospike.Exp.int_loop_var(:value), bound to each candidate child.
Deserializes a Base64-encoded context path.
Deserializes MessagePack context bytes.
Navigate into a list by absolute index.
@spec list_index_create(integer(), list_order(), boolean()) :: step()
Navigate into a list by index, creating a nested list when it is missing.
order controls the created list order. When pad is true and index is
past the current end of the list, nil elements are inserted before the new
list.
Navigate into a list by rank.
Navigate to the list element equal to value.
Navigate into a map by entry index.
Navigate into the map entry for key.
Navigate into a map by key, creating a nested map when it is missing.
Navigate into a map by value rank.
Navigate to the map entry whose value equals value.
Serializes a context path to Base64-encoded MessagePack bytes.
Serializes a context path to MessagePack bytes.