Aerospike.Exp.Map (Aerospike Driver v0.3.1)

Map CDT expression helpers.

Summary

Types

opts()

Common map expression options.

policy()

Map expression write policy accepted in opts[:policy].

return_type()

Map selector return type.

t()

Opaque server-side expression.

Functions

clear(bin)

Removes all entries from the map expression.

get_by_index(bin, index, value_type, opts \\ [])

Returns the entry at index, selected by return_type:.

get_by_index_range(bin, index, count, opts \\ [])

Returns count entries from index, selected by return_type:.

get_by_index_range_from(bin, index, opts \\ [])

Returns entries from index through the end, selected by return_type:.

get_by_key(bin, key, value_type, opts \\ [])

Returns the entry for key, selected by return_type:.

get_by_key_list(bin, keys, opts \\ [])

Returns entries matching any key in keys, selected by return_type:.

get_by_key_range(bin, begin_key, end_key, opts \\ [])

Returns entries with keys in [begin_key, end_key), selected by return_type:.

get_by_key_rel_index_range(bin, key, index, opts \\ [])

Returns entries nearest to key and greater by relative index.

get_by_key_rel_index_range_count(bin, key, index, count, opts \\ [])

Returns count entries nearest to key and greater by relative index.

get_by_rank(bin, rank, value_type, opts \\ [])

Returns the entry at rank, selected by return_type:.

get_by_rank_range(bin, rank, count, opts \\ [])

Returns count entries from rank, selected by return_type:.

get_by_rank_range_from(bin, rank, opts \\ [])

Returns entries from rank through the highest rank, selected by return_type:.

get_by_value(bin, value, opts \\ [])

Returns entries equal to value, selected by return_type:.

get_by_value_list(bin, values, opts \\ [])

Returns entries matching any value in values, selected by return_type:.

get_by_value_range(bin, begin_value, end_value, opts \\ [])

Returns entries with values in [begin_value, end_value), selected by return_type:.

get_by_value_rel_rank_range(bin, value, rank, opts \\ [])

Returns entries nearest to value and greater by relative rank.

get_by_value_rel_rank_range_count(bin, value, rank, count, opts \\ [])

Returns count entries nearest to value and greater by relative rank.

increment(bin, key, delta, opts \\ [])

Increments the numeric value at key and returns the final value. Supports policy:.

put(bin, key, value, opts \\ [])

Writes one key/value pair and returns the map size. Supports policy:.

put_items(bin, values, opts \\ [])

Writes map expression values and returns the map size. Supports policy:.

remove_by_index(bin, index, opts \\ [])

Removes the entry at index, returning data selected by return_type:.

remove_by_index_range(bin, index, count, opts \\ [])

Removes count entries from index, returning selected data.

remove_by_index_range_from(bin, index, opts \\ [])

Removes entries from index through the end, returning selected data.

remove_by_key(bin, key, opts \\ [])

Removes the entry for key, returning data selected by return_type:.

remove_by_key_list(bin, keys, opts \\ [])

Removes entries matching any key in keys, returning selected data.

remove_by_key_range(bin, begin_key, end_key, opts \\ [])

Removes entries with keys in [begin_key, end_key), returning selected data.

remove_by_key_rel_index_range(bin, key, index, opts \\ [])

Removes entries nearest to key and greater by relative index.

remove_by_key_rel_index_range_count(bin, key, index, count, opts \\ [])

Removes count entries nearest to key and greater by relative index.

remove_by_rank(bin, rank, opts \\ [])

Removes the entry at rank, returning data selected by return_type:.

remove_by_rank_range(bin, rank, count, opts \\ [])

Removes count entries from rank, returning selected data.

remove_by_rank_range_from(bin, rank, opts \\ [])

Removes entries from rank through the highest rank, returning selected data.

remove_by_value(bin, value, opts \\ [])

Removes entries equal to value, returning data selected by return_type:.

remove_by_value_list(bin, values, opts \\ [])

Removes entries matching any value in values, returning selected data.

remove_by_value_range(bin, begin_value, end_value, opts \\ [])

Removes entries with values in [begin_value, end_value), returning selected data.

remove_by_value_rel_rank_range(bin, value, rank, opts \\ [])

Removes entries nearest to value and greater by relative rank.

remove_by_value_rel_rank_range_count(bin, value, rank, count, opts \\ [])

Removes count entries nearest to value and greater by relative rank.

return_count()

Return the selected item count.

return_exists()

Return whether matching entries exist.

return_index()

Return selected item indexes.

return_inverted()

Invert the selector so it applies outside the matched range.

return_key()

Return selected keys.

return_key_value()

Return selected key/value pairs.

return_none()

Return no result for a selector expression.

return_ordered_map()

Return selected entries as an ordered map.

return_rank()

Return selected value ranks.

return_reverse_index()

Return selected reverse indexes, counted from the map end.

return_reverse_rank()

Return selected reverse ranks, counted from the highest value.

return_unordered_map()

Return selected entries as an unordered map.

return_value()

Return selected values.

size(bin)

Returns the number of entries in the map expression.