quasardb C API
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Data Structures | Typedefs | Enumerations | Functions
direct.h File Reference
#include "client.h"

Data Structures

struct  qdb_backup_options_t
 Backup additional parameters. More...
 
struct  qdb_backup_s3_options_t
 Backup S3 additional parameters. More...
 
struct  qdb_backup_progress_t
 Backup progress details. More...
 

Typedefs

typedef struct
qdb_direct_handle_internal * 
qdb_direct_handle_t
 An opaque handle to internal API-allocated structures needed for maintaining a direct connection to a cluster.
 
typedef enum qdb_backup_flags_t qdb_backup_flags_t
 Backup modification flags.
 

Enumerations

enum  qdb_backup_flags_t { qdb_backup_checkpoint = 1, qdb_backup_checkpoint_trim, qdb_backup_full }
 Backup modification flags. More...
 

Functions

QDB_API_LINKAGE qdb_direct_handle_t qdb_direct_connect (qdb_handle_t handle, const char *uri)
 Opens a direct connection to a node for use with the direct API. More...
 
QDB_API_LINKAGE void qdb_direct_close (qdb_direct_handle_t handle)
 Close a direct handle initially opened with qdb_direct_connect. More...
 
QDB_API_LINKAGE qdb_error_t qdb_direct_blob_get (qdb_direct_handle_t handle, const char *alias, const void **content, qdb_size_t *content_length)
 Retrieves an entry's content from a quasardb node's local storage. More...
 
QDB_API_LINKAGE qdb_error_t qdb_direct_blob_put (qdb_direct_handle_t handle, const char *alias, const void *content, qdb_size_t content_length, qdb_time_t expiry_time)
 Creates a new entry and sets its content to the provided blob. More...
 
QDB_API_LINKAGE qdb_error_t qdb_direct_blob_update (qdb_direct_handle_t handle, const char *alias, const void *content, qdb_size_t content_length, qdb_time_t expiry_time)
 Creates or updates an entry and sets its content to the provided blob. More...
 
QDB_API_LINKAGE qdb_error_t qdb_direct_remove (qdb_direct_handle_t handle, const char *alias)
 Removes an entry from the local node's storage, regardless of its type. More...
 
QDB_API_LINKAGE qdb_error_t qdb_direct_int_put (qdb_direct_handle_t handle, const char *alias, qdb_int_t integer, qdb_time_t expiry_time)
 Creates a new signed 64-bit integer. More...
 
QDB_API_LINKAGE qdb_error_t qdb_direct_int_update (qdb_direct_handle_t handle, const char *alias, qdb_int_t integer, qdb_time_t expiry_time)
 Creates or updates a signed 64-bit integer. More...
 
QDB_API_LINKAGE qdb_error_t qdb_direct_int_get (qdb_direct_handle_t handle, const char *alias, qdb_int_t *integer)
 Retrieves the value of a signed 64-bit integer. More...
 
QDB_API_LINKAGE qdb_error_t qdb_direct_int_add (qdb_direct_handle_t handle, const char *alias, qdb_int_t addend, qdb_int_t *result)
 Atomically increases or decreases a signed 64-bit integer. More...
 
QDB_API_LINKAGE qdb_error_t qdb_direct_prefix_get (qdb_direct_handle_t handle, const char *prefix, qdb_int_t max_count, const char ***results, size_t *result_count)
 Retrieves the list of all entries matching the provided prefix. More...
 
QDB_API_LINKAGE qdb_error_t qdb_direct_node_backup (qdb_direct_handle_t handle, const char *output_directory, const qdb_backup_options_t *options)
 Run backup process on the node. More...
 
QDB_API_LINKAGE qdb_error_t qdb_direct_node_get_backup_progress (qdb_direct_handle_t handle, qdb_uint_t *completed)
 Get the backup progress. More...
 
QDB_API_LINKAGE qdb_error_t qdb_direct_node_abort_backup (qdb_direct_handle_t handle)
 Abort the running backup. More...
 
QDB_API_LINKAGE qdb_error_t qdb_direct_node_s3_backup (qdb_direct_handle_t handle, const char *bucket, const char *path_prefix, const char *region, const qdb_backup_s3_options_t *options)
 Run backup process to S3 on the node. More...
 
QDB_API_LINKAGE qdb_error_t qdb_direct_node_get_s3_backup_progress (qdb_direct_handle_t handle, qdb_backup_progress_t *progress)
 Get the S3 backup progress. More...