![]() |
The Index API provides the ability to create and remove secondary indexes.
Aerospike currently supports indexing of strings and integers.
A string index allows for equality lookups. An equality lookup means that if you query for an indexed bin with value "abc", then only the records containing bins with "abc" will be returned.
To create a string index, see aerospike_index_string_create().
An integer index allows for either equality or range lookups. An equality lookup means that if you query for an indexed bin with value 123, then only the records containing bins with the value 123 will be returned. A range lookup means that you can query bins within a range. So, if your range is (1...100), then all records containing the a value in that range will be returned.
To create a integer index, see aerospike_index_integer_create().
Functions | |
as_status | aerospike_index_integer_create (aerospike *as, as_error *err, const as_policy_info *policy, const as_namespace ns, const as_set set, const as_bin_name bin, const char *name) |
as_status | aerospike_index_remove (aerospike *as, as_error *err, const as_policy_info *policy, const as_namespace ns, const char *name) |
as_status | aerospike_index_string_create (aerospike *as, as_error *err, const as_policy_info *policy, const as_namespace ns, const as_set set, const as_bin_name bin, const char *name) |
as_status aerospike_index_integer_create | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_info * | policy, | ||
const as_namespace | ns, | ||
const as_set | set, | ||
const as_bin_name | bin, | ||
const char * | name | ||
) |
Create a new secondary index on an integer 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. |
ns | The namespace to be indexed. |
set | The set to be indexed. |
bin | The bin to be indexed. |
name | The name of the index. |
as_status aerospike_index_remove | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_info * | policy, | ||
const as_namespace | ns, | ||
const char * | name | ||
) |
Removes (drops) a secondary index.
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. |
ns | The namespace containing the index to be removed. |
name | The name of the index to be removed. |
as_status aerospike_index_string_create | ( | aerospike * | as, |
as_error * | err, | ||
const as_policy_info * | policy, | ||
const as_namespace | ns, | ||
const as_set | set, | ||
const as_bin_name | bin, | ||
const char * | name | ||
) |
Create a new secondary index on a string 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. |
ns | The namespace to be indexed. |
set | The set to be indexed. |
bin | The bin to be indexed. |
name | The name of the index. |