Map bin operations

Aerospike map bin expressions allow you to modify and query map-type bins directly in database queries.

This guide explains operations like map_clear, map_put, map_increment, and various remove and update functions. These expressions enable efficient handling of map data, allowing you to read, modify values, add new entries, and remove elements based on keys, ranks, and indices.

Modify

`map_clear`

map_clear(context, bin)

Description

Clear all elements in map bin.

Arguments

Name	Type
`context`	`library_specific`
`bin`	`map_bin_expr`

Returns

map_bin

Introduced

5.2.0.4

`map_increment`

map_increment(context, policy, key, delta, bin)

Description

Increment element at key by delta.

Arguments

Name	Type
`context`	`library_specific`
`policy`	`library_specific`
`key`	`expr`
`delta`	`integer_expr`
`bin`	`map_bin_expr`

Returns

map_bin

Introduced

5.2.0.4

`map_put`

map_put(context, policy, key, value, bin)

Description

Add {key, value} element to bin. map_put does not create a new bin if the specified bin does not exist, unlike the put CDT Map operation, which does create a new bin if the specified bin does not exist.

Arguments

Name	Type
`context`	`library_specific`
`policy`	`library_specific`
`key`	`expr`
`value`	`expr`
`bin`	`map_bin_expr`

Returns

map_bin

Introduced

5.2.0.4

`map_put_items`

map_put_items(context, policy, items, bin)

Description

Add elements in items to bin. map_put_items does not create a new bin if the specified bin does not exist, unlike the put_items CDT Map operation, which does create a new bin if the specified bin does not exist.

Arguments

Name	Type
`context`	`library_specific`
`policy`	`library_specific`
`items`	`map_expr`
`bin`	`map_bin_expr`

Returns

map_bin

Introduced

5.2.0.4

`map_remove_by_index`

map_remove_by_index(context, index, bin)

Description

Remove element at index.

Arguments

Name	Type
`context`	`library_specific`
`index`	`integer_expr`
`bin`	`map_bin_expr`

Returns

map_bin

Introduced

5.2.0.4

`map_remove_by_index_range`

map_remove_by_index_range(context, index, count, bin)

Description

Remove count element at index.

Arguments

Name	Type
`context`	`library_specific`
`index`	`integer_expr`
`count`	`integer_expr`
`bin`	`map_bin_expr`

Returns

map_bin

Introduced

5.2.0.4

`map_remove_by_index_range_to_end`

map_remove_by_index_range_to_end(context, index, bin)

Description

Remove all element at and after index.

Arguments

Name	Type
`context`	`library_specific`
`index`	`integer_expr`
`bin`	`map_bin_expr`

Returns

map_bin

Introduced

5.2.0.4

`map_remove_by_key`

map_remove_by_key(context, key, bin)

Description

Remove element with key key.

Arguments

Name	Type
`context`	`library_specific`
`key`	`expr`
`bin`	`map_bin_expr`

Returns

map_bin

Introduced

5.2.0.4

`map_remove_by_key_list`

map_remove_by_key_list(context, keys, bin)

Description

Remove all elements where key ∈ keys.

Arguments

Name	Type
`context`	`library_specific`
`keys`	`list_expr`
`bin`	`map_bin_expr`

Returns

map_bin

Introduced

5.2.0.4

`map_remove_by_key_range`

map_remove_by_key_range(context, start, end, bin)

Description

Remove all elements with key k in interval start ≤ k < end.

Arguments

Name	Type
`context`	`library_specific`
`start`	`expr`
`end`	`expr`
`bin`	`map_bin_expr`

Returns

map_bin

Introduced

5.2.0.4

`map_remove_by_rank`

map_remove_by_rank(context, rank, bin)

Description

Remove all element with rank rank.

Arguments

Name	Type
`context`	`library_specific`
`rank`	`integer_expr`
`bin`	`map_bin_expr`

Returns

map_bin

Introduced

5.2.0.4

`map_remove_by_rank_range`

map_remove_by_rank_range(context, rank, count, bin)

Description

Remove count element at rank.

Arguments

Name	Type
`context`	`library_specific`
`rank`	`integer_expr`
`count`	`integer_expr`
`bin`	`map_bin_expr`

Returns

map_bin

Introduced

5.2.0.4

`map_remove_by_rank_range_to_end`

map_remove_by_rank_range_to_end(context, rank, bin)

Description

Remove all elements at and after rank.

Arguments

Name	Type
`context`	`library_specific`
`rank`	`integer_expr`
`bin`	`map_bin_expr`

Returns

map_bin

Introduced

5.2.0.4

`map_remove_by_rel_index_range`

map_remove_by_rel_index_range(context, key, index, count, bin)

Description

Remove count elements at index relative to key.

Arguments

Name	Type
`context`	`library_specific`
`key`	`expr`
`index`	`integer_expr`
`count`	`integer_expr`
`bin`	`map_bin_expr`

Returns

map_bin

Introduced

5.2.0.4

`map_remove_by_rel_index_range_to_end`

map_remove_by_rel_index_range_to_end(context, key, index, bin)

Description

Remove all elements at and after index relative to key.

Arguments

Name	Type
`context`	`library_specific`
`key`	`expr`
`index`	`integer_expr`
`bin`	`map_bin_expr`

Returns

map_bin

Introduced

5.2.0.4

`map_remove_by_rel_rank_range`

map_remove_by_rel_rank_range(context, value, rank, count, bin)

Description

Remove count elements at rank relative to value.

Arguments

Name	Type
`context`	`library_specific`
`value`	`expr`
`rank`	`integer_expr`
`count`	`integer_expr`
`bin`	`map_bin_expr`

Returns

map_bin

Introduced

5.2.0.4

`map_remove_by_rel_rank_range_to_end`

map_remove_by_rel_rank_range_to_end(context, value, rank, bin)

Description

Remove all elements at and after rank relative to value.

Arguments

Name	Type
`context`	`library_specific`
`value`	`expr`
`rank`	`integer_expr`
`bin`	`map_bin_expr`

Returns

map_bin

Introduced

5.2.0.4

`map_remove_by_value`

map_remove_by_value(context, value, bin)

Description

Remove all element with value value.

Arguments

Name	Type
`context`	`library_specific`
`value`	`expr`
`bin`	`map_bin_expr`

Returns

map_bin

Introduced

5.2.0.4

`map_remove_by_value_list`

map_remove_by_value_list(context, values, bin)

Description

Remove all elements where value ∈ values.

Arguments

Name	Type
`context`	`library_specific`
`values`	`list_expr`
`bin`	`map_bin_expr`

Returns

map_bin

Introduced

5.2.0.4

`map_remove_by_value_range`

map_remove_by_value_range(context, start, end, bin)

Description

Remove all elements with value v in interval start ≤ v < end.

Arguments

Name	Type
`context`	`library_specific`
`start`	`expr`
`end`	`expr`
`bin`	`map_bin_expr`

Returns

map_bin

Introduced

5.2.0.4

Read

`map_get_by_index`

map_get_by_index(type, context, result_type, index, bin)

Description

Get element at index.

Arguments

Name	Type
`type`	`integer_value`
`context`	`library_specific`
`result_type`	`integer_value`
`index`	`integer_expr`
`bin`	`map_bin_expr`

Introduced

5.2.0.4

`map_get_by_index_range`

map_get_by_index_range(context, result_type, index, count, bin)

Description

Get count elements at index.

Arguments

Name	Type
`context`	`library_specific`
`result_type`	`integer_value`
`index`	`integer_expr`
`count`	`integer_expr`
`bin`	`map_bin_expr`

Introduced

5.2.0.4

`map_get_by_index_range_to_end`

map_get_by_index_range_to_end(context, result_type, index, bin)

Description

Get elements at and after index.

Arguments

Name	Type
`context`	`library_specific`
`result_type`	`integer_value`
`index`	`integer_expr`
`bin`	`map_bin_expr`

Introduced

5.2.0.4

`map_get_by_key`

map_get_by_key(type, context, result_type, key, bin)

Description

Get element with key == key.

Arguments

Name	Type
`type`	`integer_value`
`context`	`library_specific`
`result_type`	`integer_value`
`key`	`expr`
`bin`	`map_bin_expr`

Introduced

5.2.0.4

`map_get_by_key_list`

map_get_by_key_list(context, result_type, keys, bin)

Description

Get all elements where key ∈ keys.

Arguments

Name	Type
`context`	`library_specific`
`result_type`	`integer_value`
`keys`	`list_expr`
`bin`	`map_bin_expr`

Introduced

5.2.0.4

`map_get_by_key_range`

map_get_by_key_range(context, result_type, start, end, bin)

Description

Get all elements with key k in interval start ≤ k < end.

Arguments

Name	Type
`context`	`library_specific`
`result_type`	`integer_value`
`start`	`expr`
`end`	`expr`
`bin`	`map_bin_expr`

Introduced

5.2.0.4

`map_get_by_rank`

map_get_by_rank(type, context, result_type, rank, bin)

Description

Get element at rank.

Arguments

Name	Type
`type`	`integer_value`
`context`	`library_specific`
`result_type`	`integer_value`
`rank`	`integer_expr`
`bin`	`map_bin_expr`

Introduced

5.2.0.4

`map_get_by_rank_range`

map_get_by_rank_range(context, result_type, rank, count, bin)

Description

Get count element at rank.

Arguments

Name	Type
`context`	`library_specific`
`result_type`	`integer_value`
`rank`	`integer_expr`
`count`	`integer_expr`
`bin`	`map_bin_expr`

Introduced

5.2.0.4

`map_get_by_rank_range_to_end`

map_get_by_rank_range_to_end(context, result_type, rank, bin)

Description

Get all elements at and after rank.

Arguments

Name	Type
`context`	`library_specific`
`result_type`	`integer_value`
`rank`	`integer_expr`
`bin`	`map_bin_expr`

Introduced

5.2.0.4

`map_get_by_rel_index_range`

map_get_by_rel_index_range(context, result_type, key, index, count_expr, bin)

Description

Get count elements at index relative to key.

Arguments

Name	Type
`context`	`library_specific`
`result_type`	`integer_value`
`key`	`expr`
`index`	`integer_expr`
`count_expr`	`integer_expr`
`bin`	`map_bin_expr`

Introduced

5.2.0.4

`map_get_by_rel_index_range_to_end`

map_get_by_rel_index_range_to_end(context, result_type, key, index_expr, bin)

Description

Get all elements at and after index relative to key.

Arguments

Name	Type
`context`	`library_specific`
`result_type`	`integer_value`
`key`	`expr`
`index_expr`
`bin`	`map_bin_expr`

Introduced

5.2.0.4

`map_get_by_rel_rank_range`

map_get_by_rel_rank_range(context, result_type, value, rank, count, bin)

Description

Remove count elements at rank relative to value.

Arguments

Name	Type
`context`	`library_specific`
`result_type`	`integer_value`
`value`	`expr`
`rank`	`integer_expr`
`count`	`integer_expr`
`bin`	`map_bin_expr`

Introduced

5.2.0.4

`map_get_by_rel_rank_range_to_end`

map_get_by_rel_rank_range_to_end(context, result_type, value, rank, bin)

Description

Remove all elements at and after rank relative to value.

Arguments

Name	Type
`context`	`library_specific`
`result_type`	`integer_value`
`value`	`expr`
`rank`	`integer_expr`
`bin`	`map_bin_expr`

Introduced

5.2.0.4

`map_get_by_value`

map_get_by_value(context, result_type, value, bin)

Description

Get all elements where value == value.

Arguments

Name	Type
`context`	`library_specific`
`result_type`	`integer_value`
`value`	`expr`
`bin`	`map_bin_expr`

Introduced

5.2.0.4

`map_get_by_value_list`

map_get_by_value_list(context, result_type, values, bin)

Description

Get all elements where value ∈ values.

Arguments

Name	Type
`context`	`library_specific`
`result_type`	`integer_value`
`values`	`list_expr`
`bin`	`map_bin_expr`

Introduced

5.2.0.4

`map_get_by_value_range`

map_get_by_value_range(context, result_type, start, end, bin)

Description

Get all elements with value v in interval start ≤ v < end.

Arguments

Name	Type
`context`	`library_specific`
`result_type`	`integer_value`
`start`	`integer_expr`
`end`	`integer_expr`
`bin`	`map_bin_expr`

Introduced

5.2.0.4

`map_size`

map_size(context, bin)

Description

Get number of items in the map.

Arguments

Name	Type
`context`	`library_specific`
`bin`	`map_bin_expr`

Returns

integer_bin

Introduced

5.2.0.4