![]() |
The ldt_operations module provides API to manipulate Large Data Types. Currently supported types include:
Forthcoming API:
as_status aerospike_llist_add | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
const as_val * | val | ||
) |
Functionality related to Large List Data Type Add a value into the llist.
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The ldt bin to insert values to. |
val | The value to insert into the llist. |
as_status aerospike_llist_add_all | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
const as_list * | vals | ||
) |
Add a list of values into the llist.
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The ldt bin to insert values to. |
vals | The list of values to insert into the llist. |
as_status aerospike_llist_destroy | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt | ||
) |
Destroy the llist bin
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The llist bin to destroy. If not an llist bin, will return error. |
as_status aerospike_llist_filter | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
const as_udf_function_name | filter, | ||
const as_list * | filter_args, | ||
as_list ** | elements | ||
) |
Given an llist bin, filter the collection of objects using the given filter function. If no filter function is specified, return all values.
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The llist bin to search from. If not an llist bin, will return error. |
filter | The name of the User-Defined-Function to use as a search filter. |
fargs | The list of parameters passed in to the User-Defined-Function filter. |
list | The pointer to a list of elements returned from search function. Pointer should be NULL passed in. |
as_status aerospike_llist_find | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
const as_val * | search_val, | ||
as_list ** | elements | ||
) |
Search for a value in the llist.
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The llist bin to lookup from. If not an llist bin, will return error. |
search_val | The search value |
result_list | The returned list of values |
as_status aerospike_llist_get_capacity | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
uint32_t * | ldt_capacity | ||
) |
Check the storage capacity for this LDT.
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The LDT to operate on. If not an LLIST bin, will return error. |
ldt_capacity | Set by function to 1 for true, 0 for false |
as_status aerospike_llist_ldt_exists | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
as_boolean * | ldt_exists | ||
) |
Check to see if an LLIST object exists in this record bin.
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The LDT to operate on. If not an LLIST bin, will return error. |
ldt_exists | Ptr to as_boolean: Set to TRUE if ldt exists, otherwise false. |
as_status aerospike_llist_range | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
const as_val * | min_value, | ||
const as_val * | max_value, | ||
const as_udf_function_name | filter, | ||
const as_list * | filter_args, | ||
as_list ** | elements | ||
) |
Given an llist bin, return the key values from MIN to MAX, and then filter the returned collection of objects using the given filter function. If no filter function is specified, return all values.
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The llist bin to search from. If not an llist bin, will return error. |
min_value | The minimum range value (or null to be LEAST value) |
max_value | The maximum range value (or null to be the GREATEST value) |
filter | The name of the User-Defined-Function to use as a search filter (or null if no filter) |
fargs | The list of parameters passed in to the User-Defined-Function filter (or null) |
list | The pointer to a list of elements returned from search function. Pointer should be NULL passed in. |
as_status aerospike_llist_remove | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
const as_val * | element | ||
) |
Delete the given value from the llist
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The llist bin to delete from. If not an llist bin, will return error. |
val | The value to delete from the set. |
as_status aerospike_llist_scan | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
as_list ** | elements | ||
) |
Given an llist bin, return all values in the list.
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The llist bin to search from. If not an llist bin, will return error. |
list | The pointer to a list of elements returned from search function. Pointer should be NULL passed in. |
as_status aerospike_llist_set_capacity | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
uint32_t | ldt_capacity | ||
) |
SET the storage capacity for this LDT.
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The LDT to operate on. If not an LLIST bin, will return error. |
ldt_capacity | Set by function to 1 for true, 0 for false |
as_status aerospike_llist_size | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
uint32_t * | n | ||
) |
Look up a llist and find how many elements it contains
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The llist to operate on. If not an llist bin, will return error. |
n | Return the number of elements in the llist. |
as_status aerospike_lmap_destroy | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt | ||
) |
Destroy the lmap bin
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The lmap bin to destroy. If not an lmap bin, will return error. |
as_status aerospike_lmap_filter | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
const as_udf_function_name | filter, | ||
const as_list * | filter_args, | ||
as_map ** | elements | ||
) |
Given an lmap bin, scan through all entries in the map, and apply the given filter function. If no filter function is specified, all values in the lmap will be returned.
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The lmap bin to operate on. If not an lmap bin, will return error. |
filter | The name of the User-Defined-Function to use as a read-filter. The UDF should either return the entry, or nil, if filtered out. |
fargs | The list of parameters passed in to the User-Defined-Function filter. |
elements | The pointer to a map of entries returned from the function. Pointer should be NULL passed in. |
as_status aerospike_lmap_get | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
const as_val * | mkey, | ||
as_val ** | mval | ||
) |
Get the value of an entry in the Lmap, using the given map-key
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The lmap bin to lookup from. If not an lmap bin, will return error. |
exists | Returned boolean value to indicate value exists. |
as_status aerospike_lmap_get_all | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
as_map ** | elements | ||
) |
Get all the entries in an lmap
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The lmap bin to lookup from. If not an lmap bin, will return error. |
elements | Returned pointer to the map of entries. |
as_status aerospike_lmap_get_capacity | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
uint32_t * | ldt_capacity | ||
) |
Get an LDTs storage capacity (in number of elements)
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The LDT bin to operate on |
ldt_capacity | The LDT Capacity, in terms of elements, not bytes. |
as_status aerospike_lmap_ldt_exists | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
as_boolean * | ldt_exists | ||
) |
Check to see if an LDT object exists in this record bin.
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The LDT to operate on. If not an LMAP bin, will return error. |
ldt_exists | Ptr to as_boolean: Set to TRUE if ldt exists, otherwise false. |
as_status aerospike_lmap_put | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
const as_val * | mkey, | ||
const as_val * | mval | ||
) |
Functionality related to Large Map Data Type Add a value into the lmap.
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The ldt bin to insert values to. |
mkey | The map-key. |
val | The map-value associated with mkey. |
as_status aerospike_lmap_put_all | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
const as_map * | vals | ||
) |
Add multiple entries into the lmap.
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The ldt bin to insert values to. |
vals | A map containing the entries to add to the lmap. |
as_status aerospike_lmap_remove | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
const as_val * | mkey | ||
) |
Delete the given value from the lmap
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The lmap bin to delete from. If not an lmap bin, will return error. |
val | The value to delete from the set. |
as_status aerospike_lmap_set_capacity | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
uint32_t | ldt_capacity | ||
) |
Change an LDT storage capacity (in number of elements)
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The LDT to check |
ldt_capacity | The new capacity for this LDT, in terms of elements, not bytes |
as_status aerospike_lmap_size | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
uint32_t * | n | ||
) |
Look up a lmap and find how many elements it contains
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The lmap to operate on. If not an lmap bin, will return error. |
n | Return the number of elements in the lmap. |
as_status aerospike_lset_add | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
const as_val * | val | ||
) |
Functionality related to Large Set Data Type Add a value into the lset.
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The ldt bin to insert values to. |
val | The value to insert into the lset. |
as_status aerospike_lset_add_all | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
const as_list * | vals | ||
) |
Add a list of values into the lset.
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The ldt bin to insert values to. |
vals | The list of values to insert into the lset. |
as_status aerospike_lset_destroy | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt | ||
) |
Destroy the lset bin
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The lset bin to destroy. If not an lset bin, will return error. |
as_status aerospike_lset_exists | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
const as_val * | val, | ||
as_boolean * | exists | ||
) |
See if a value exists in an lset
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The lset bin to lookup from. If not an lset bin, will return error. |
val | The value we're searching for. |
exists | Returned boolean value to indicate value exists. |
as_status aerospike_lset_filter | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
const as_udf_function_name | filter, | ||
const as_list * | filter_args, | ||
as_list ** | elements | ||
) |
Given an lset bin, filter the set of objects using the given filter function. If no filter function is specified, all values in the set will be returned.
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The lset bin to search from. If not an lset bin, will return error. |
filter | The name of the User-Defined-Function to use as a search filter. |
fargs | The list of parameters passed in to the User-Defined-Function filter. |
list | The pointer to a list of elements returned from search function. Pointer should be NULL passed in. |
as_status aerospike_lset_get | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
const as_val * | val, | ||
as_val ** | pp_return_val | ||
) |
Fetch (get) a value from the lset. Note that this is useful mainly in the case where the search criteria for an object is less than the entire object – and that is when the standard defaults are overridden and the unique_identifier() function is employed to use only part of the object for search and compare. The unique_identifier() function is defined on create – and declared in the USER_MODULE.
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The lset bin to lookup from. If not an lset bin, will return error. |
val | The value we're searching for. |
pp_return_val | Returned value. |
as_status aerospike_lset_get_capacity | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
uint32_t * | ldt_capacity | ||
) |
Get an LDTs storage capacity (in number of elements)
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The LDT bin to operate on |
ldt_capacity | The LDT Capacity, in terms of elements, not bytes. |
as_status aerospike_lset_ldt_exists | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
as_boolean * | ldt_exists | ||
) |
Check to see if an LDT object exists in this record bin.
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The LDT to operate on. If not an LMAP bin, will return error. |
ldt_exists | Ptr to as_boolean: Set to TRUE if ldt exists, otherwise false. |
as_status aerospike_lset_remove | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
const as_val * | element | ||
) |
Delete the given value from the lset
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The lset bin to delete from. If not an lset bin, will return error. |
val | The value to delete from the set. |
as_status aerospike_lset_scan | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
as_list ** | elements | ||
) |
Given an lset bin, scan for all the values in the set
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The lset bin to search from. If not an lset bin, will return error. |
list | The pointer to a list of elements returned from search function. Pointer should be NULL passed in. |
as_status aerospike_lset_set_capacity | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
uint32_t | ldt_capacity | ||
) |
Change an LDT storage capacity (in number of elements)
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The LDT to check |
ldt_capacity | The number of elements cap for the LDT. |
as_status aerospike_lset_size | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
uint32_t * | n | ||
) |
Look up a lset and find how many elements it contains
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The lset to operate on. If not an lset bin, will return error. |
n | Return the number of elements in the lset. |
as_status aerospike_lstack_destroy | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt | ||
) |
Destroys an existing lstack
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The stack bin to peek values from. If not a stack bin, will return error. |
as_status aerospike_lstack_filter | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
uint32_t | peek_count, | ||
const as_udf_function_name | filter, | ||
const as_list * | filter_args, | ||
as_list ** | elements | ||
) |
Look up a record by key, then peek into a stack bin, and do UDF post processing to filter for only the desired values.
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The stack bin to peek values from. If not a stack bin, will return error. |
n | The number of elements to peek from the lstack. |
filter | The name of the User-Defined-Function to use as a stack element filter. |
fargs | The list of parameters to the User-Defined-Function filter. |
list | Pointer to list of elements peeked from the lstack. Pointer should be initialized to NULL when passed in; |
as_status aerospike_lstack_get_capacity | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
uint32_t * | ldt_capacity | ||
) |
Get an lstack's storage capacity (in number of elements)
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The stack bin to peek values from. If not a stack bin, will return error. |
ldt_capacity | The LDT Capacity, in terms of elements, not bytes. |
as_status aerospike_lstack_ldt_exists | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
as_boolean * | ldt_exists | ||
) |
Check to see if an LSTACK object exists in this record bin.
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The LDT to operate on. If not an LSTACK bin, will return error. |
ldt_exists | Ptr to as_boolean: Set to TRUE if ldt exists, otherwise false. |
as_status aerospike_lstack_peek | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
uint32_t | peek_count, | ||
as_list ** | elements | ||
) |
Look up an lstack, then peek to get the top n values from the stack.
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The stack bin to peek values from. If not a stack bin, will return error. |
n | The number of elements to peek from the lstack. |
list | Pointer to a list of elements peeked from the lstack. Pointer should be NULL passed in. If stack_size shorter than n, only stack_size is returned. |
as_status aerospike_lstack_push | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
const as_val * | val | ||
) |
Push a value onto the lstack.
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The ldt bin to push values to. |
val | The value to push on to the lstack. |
as_status aerospike_lstack_push_all | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
const as_list * | vals | ||
) |
Push a value onto the lstack.
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The ldt bin to push values to. |
vals | The list of values to push on to the lstack. list[0] is the first to push on the stack. list[n] is top of the stack. |
as_status aerospike_lstack_set_capacity | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
uint32_t | ldt_capacity | ||
) |
Change an LDT storage capacity (in number of elements)
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The stack bin to peek values from. If not a stack bin, will return error. |
ldt_capacity | The number of elements cap for the lstack. |
as_status aerospike_lstack_size | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_apply * | policy, | ||
const as_key * | key, | ||
const as_ldt * | ldt, | ||
uint32_t * | n | ||
) |
Find how many elements are on the lstack
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
key | The key of the record. |
ldt | The stack bin to peek values from. If not a stack bin, will return error. |
n | Return the number of elements on the lstack. |