![]() |
An instance of aerospike is required to connect to and execute operations against an Aerospike Database cluster.
An initialized client configuration is required to initialize a aerospike client. See as_config for details on configuration options.
At a minimum, a configuration needs to be initialized and have at least one host defined:
A single host is used to specify a host in the database cluster to connect to. Once connected to a host in the cluster, then client will gather information about the cluster, including all the other nodes in the cluster. So, all that is needed is a single valid host, because once a single host is connected, the then no other hosts in the configuration will be processed.
An initialized aerospike object is required to connect to the database. Initialization requires a configuration, to bind to the client instance.
The aerospike object can be initialized via either:
Both initialization functions require a configuration.
The following uses a stack allocated aerospike and initializes it with aerospike_init():
An application can connect to the database with an initialized aerospike. At this point, the client has not connected. The client will be connected if aerospike_connect()
completes successfully:
The err
parameter will be populated if an error while attempting to connect to the database. See as_error, for more information on error handling.
When the connection to the database is not longer required, then the connection to the cluster can be closed via aerospike_close()
:
When the client is not longer required, the client and its resources should be releases via aerospike_destroy()
:
Definition at line 161 of file aerospike.h.
#include "aerospike.h"
Data Fields | |
as_config | config |
as_log | log |
Private Attributes | |
bool | _free |
struct cl_cluster_s * | cluster |
Related Functions | |
(Note that these are not member functions.) | |
as_status | aerospike_close (aerospike *as, as_error *err) |
as_status | aerospike_connect (aerospike *as, as_error *err) |
void | aerospike_destroy (aerospike *as) |
aerospike * | aerospike_init (aerospike *as, as_config *config) |
aerospike * | aerospike_new (as_config *config) |
Close connections to the cluster.
as | The aerospike instance to disconnect from a cluster. |
err | If an error occurs, the err will be populated. |
Connect an aerospike instance to the cluster.
Once you are finished using the connection, then you must close it via the aerospike_close()
function.
If connect fails, then you do not need to call aerospike_close()
.
as | The aerospike instance to connect to a cluster. |
err | If an error occurs, the err will be populated. |
|
related |
Destroy the aerospike instance and associated resources.
as | The aerospike instance to destroy |
Initialize a stack allocated aerospike instance.
The config parameter can be an instance of as_config
or NULL
. If NULL
, then the default configuration will be used.
Once you are finished using the instance, then you should destroy it via the aerospike_destroy()
function.
as | The aerospike instance to initialize. |
config | The configuration to use for the instance. |
Creates a new heap allocated aerospike instance.
Once you are finished using the instance, then you should destroy it via the aerospike_destroy()
function.
config | The configuration to use for the instance. |
|
private |
If true, then as_query_destroy() will free this instance.
Definition at line 167 of file aerospike.h.
|
private |
Cluster state. This is for internal use only. Do not use this in the application.
Definition at line 174 of file aerospike.h.
as_config aerospike::config |
client configuration
Definition at line 179 of file aerospike.h.
as_log aerospike::log |
client logging
Definition at line 184 of file aerospike.h.