quasardb C API
Loading...
Searching...
No Matches
Typedefs | Enumerations | Functions
option.h File Reference
#include "client.h"

Typedefs

typedef enum qdb_compression_t qdb_compression_t
 An enumeration of compression parameters.
 
typedef enum qdb_encryption_t qdb_encryption_t
 An enumeration of encryption parameters.
 

Enumerations

enum  qdb_compression_t { qdb_comp_none = 0 , qdb_comp_fast = 1 , qdb_comp_best = 2 }
 An enumeration of compression parameters. More...
 
enum  qdb_encryption_t { qdb_crypt_none = 0 , qdb_crypt_aes_gcm_256 = 1 }
 An enumeration of encryption parameters. More...
 

Functions

QDB_API_LINKAGE qdb_error_t qdb_option_set_timeout (qdb_handle_t handle, int timeout_ms)
 Sets the timeout of all network operations.
 
QDB_API_LINKAGE qdb_error_t qdb_option_get_timeout (qdb_handle_t handle, int *timeout_ms)
 Gets the timeout of all network operations.
 
QDB_API_LINKAGE qdb_error_t qdb_option_set_client_max_in_buf_size (qdb_handle_t handle, size_t max_size)
 Sets the maximum incoming buffer size for all network operations of the client.
 
QDB_API_LINKAGE qdb_error_t qdb_option_get_client_max_in_buf_size (qdb_handle_t handle, size_t *max_size)
 Gets the maximum incoming buffer size for all network operations of the client.
 
QDB_API_LINKAGE qdb_error_t qdb_option_get_cluster_max_in_buf_size (qdb_handle_t handle, size_t *max_size)
 Gets the maximum incoming buffer size for all network operations of the remote cluster.
 
QDB_API_LINKAGE qdb_error_t qdb_option_set_stabilization_max_wait (qdb_handle_t handle, int wait_ms)
 Sets the maximum stabilization waiting time for operations.
 
QDB_API_LINKAGE qdb_error_t qdb_option_get_stabilization_max_wait (qdb_handle_t handle, int *wait_ms)
 Gets the maximum stabilization waiting time for operations.
 
QDB_API_LINKAGE qdb_error_t qdb_option_set_transaction_max_wait (qdb_handle_t handle, int wait_ms)
 Sets the maximum transaction retry time for operations.
 
QDB_API_LINKAGE qdb_error_t qdb_option_get_transaction_max_wait (qdb_handle_t handle, int *wait_ms)
 Gets the maximum transaction retry time for operations.
 
QDB_API_LINKAGE qdb_error_t qdb_option_set_max_cardinality (qdb_handle_t handle, qdb_uint_t max_cardinality)
 Sets the maximum allowed cardinality of a quasardb query. The default value is 100'003. The minimum allowed value is 100.
 
QDB_API_LINKAGE qdb_error_t qdb_option_set_client_max_parallelism (qdb_handle_t handle, qdb_size_t thread_count)
 Sets the number of threads that will be used to execute queries by the current handle.
 
QDB_API_LINKAGE qdb_error_t qdb_option_get_client_max_parallelism (qdb_handle_t handle, qdb_size_t *thread_count)
 Gets the number of threads that will be used to execute queries by the current handle.
 
QDB_API_LINKAGE qdb_error_t qdb_option_get_client_load_balancing (qdb_handle_t handle, int *is_enabled)
 Gets the state of the load-balancing.
 
QDB_API_LINKAGE qdb_error_t qdb_option_enable_client_load_balancing (qdb_handle_t handle)
 Enables load-balancing for all threads.
 
QDB_API_LINKAGE qdb_error_t qdb_option_disable_client_load_balancing (qdb_handle_t handle)
 Disables load-balancing for all threads.
 
QDB_API_LINKAGE qdb_error_t qdb_option_set_compression (qdb_handle_t handle, qdb_compression_t comp_level)
 Set the compression level for all future messages emitted by the specified handle. Regardless of this parameter, the API will be able to read whatever compression the server uses.
 
QDB_API_LINKAGE qdb_error_t qdb_option_set_encryption (qdb_handle_t handle, qdb_encryption_t encryption)
 Set the encryption method for all future messages emitted by the specified handle.
 
QDB_API_LINKAGE qdb_error_t qdb_option_set_cluster_public_key (qdb_handle_t handle, const char *public_key)
 Set the public key of the cluster used for authentification of nodes on connection.
 
QDB_API_LINKAGE qdb_error_t qdb_option_set_user_credentials (qdb_handle_t handle, const char *user_name, const char *private_key)
 Set the user credentials (name and private key) used for authentification of the user on connection.
 
QDB_API_LINKAGE qdb_error_t qdb_option_load_security_files (qdb_handle_t handle, const char *cluster_public_key_file, const char *user_credentials_file)
 Set the user credentials and cluster public key used for authentification of the user on connection.
 
QDB_API_LINKAGE qdb_error_t qdb_option_set_ts_batch_push_async_timeout (qdb_handle_t handle, int timeout_ms)
 Sets the timeout of qdb_ts_batch_push_async operation.
 
QDB_API_LINKAGE qdb_error_t qdb_option_get_ts_batch_push_async_timeout (qdb_handle_t handle, int *timeout_ms)
 Gets the timeout of qdb_ts_batch_push_async operation.
 
QDB_API_LINKAGE qdb_error_t qdb_option_cluster_enable_auto_compaction (qdb_handle_t handle)
 Enables automatic compactions in the cluster's persistence.
 
QDB_API_LINKAGE qdb_error_t qdb_option_cluster_disable_auto_compaction (qdb_handle_t handle)
 Disables automatic compactions in the cluster's persistence. Manual compaction is still possible.
 
QDB_API_LINKAGE qdb_error_t qdb_option_set_query_max_length (qdb_handle_t handle, qdb_size_t max_query_length)
 Sets the maximum length of query strings.
 
QDB_API_LINKAGE qdb_error_t qdb_option_get_query_max_length (qdb_handle_t handle, qdb_size_t *max_query_length)
 Gets the maximum length of query strings.
 
QDB_API_LINKAGE qdb_error_t qdb_option_cluster_tidy_memory (qdb_handle_t handle)
 EXPERIMENTAL. Use at your own risk!
 
QDB_API_LINKAGE qdb_error_t qdb_option_set_client_soft_memory_limit (qdb_handle_t handle, qdb_uint_t limit)
 EXPERIMENTAL. Use at your own risk!
 
QDB_API_LINKAGE qdb_error_t qdb_option_client_get_memory_info (qdb_handle_t handle, const char **content, qdb_size_t *content_length)
 EXPERIMENTAL. Use at your own risk!
 
QDB_API_LINKAGE qdb_error_t qdb_option_client_tidy_memory (qdb_handle_t handle)
 EXPERIMENTAL. Use at your own risk!