Couchbase C Client
3.3.15
Asynchronous C Client for Couchbase
|
Main header file for Couchbase. More...
#include <stddef.h>
#include <time.h>
#include <stdarg.h>
#include <stdio.h>
#include <libcouchbase/sysdefs.h>
#include <libcouchbase/assert.h>
#include <libcouchbase/visibility.h>
#include <libcouchbase/error.h>
#include <libcouchbase/iops.h>
#include <libcouchbase/configuration.h>
#include <libcouchbase/kvbuf.h>
#include <libcouchbase/auth.h>
#include <libcouchbase/metrics.h>
#include <libcouchbase/tracing.h>
#include <libcouchbase/logger.h>
#include <libcouchbase/cntl.h>
Go to the source code of this file.
Macros | |
#define | LCB_CALLBACK_VIEWQUERY |
Callback type for views (cannot be used for lcb_install_callback3()) | |
#define | LCB_CALLBACK_QUERY |
Callback type for N1QL (cannot be used for lcb_install_callback3()) | |
#define | LCB_CALLBACK_IXMGMT |
Callback type for N1QL index management (cannot be used for lcb_install_callback3()) | |
#define | LCB_CALLBACK_ANALYTICS |
Callback type for Analytics (cannot be used for lcb_install_callback3()) | |
#define | LCB_CALLBACK_SEARCH |
Callback type for Search (cannot be used for lcb_install_callback3()) | |
#define | LCB_CALLBACK_OPEN |
#define | LCB_DATATYPE_JSON |
#define | LCB_VERSION_STRING |
libcouchbase version string | |
#define | LCB_VERSION |
libcouchbase hex version | |
#define | LCB_VERSION_CHANGESET |
The SCM revision ID. | |
#define | LCB_SUPPORTS_SSL |
Whether the library has SSL support. | |
#define | LCB_SUPPORTS_SNAPPY |
Whether the library has experimental compression support. | |
#define | LCB_SUPPORTS_TRACING |
Whether the library has experimental tracing support. | |
#define | LCB_SUBDOCSPECS_F_MKINTERMEDIATES |
Create intermediate paths. | |
#define | LCB_SUBDOCSPECS_F_XATTRPATH |
Access document XATTR path. | |
#define | LCB_SUBDOCSPECS_F_XATTR_MACROVALUES |
Access document virtual/materialized path. | |
#define | LCB_SUBDOCSPECS_F_XATTR_DELETED_OK |
Access Xattrs of deleted documents. | |
Typedefs | |
typedef struct lcb_st | lcb_INSTANCE |
Library handle representing a connection to a cluster and its data buckets. | |
typedef struct lcb_HTTP_HANDLE_ | lcb_HTTP_HANDLE |
typedef struct lcb_CREATEOPTS_ | lcb_CREATEOPTS |
typedef void(* | lcb_bootstrap_callback) (lcb_INSTANCE *instance, lcb_STATUS err) |
Bootstrap callback. | |
typedef void | lcb_CMDBASE |
typedef void | lcb_RESPBASE |
typedef void(* | lcb_RESPCALLBACK) (lcb_INSTANCE *instance, int cbtype, const lcb_RESPBASE *resp) |
Callback invoked for responses. | |
typedef struct lcb_RESPGET_ | lcb_RESPGET |
Command for retrieving a single item. | |
typedef struct lcb_CMDGET_ | lcb_CMDGET |
typedef struct lcb_RESPGETREPLICA_ | lcb_RESPGETREPLICA |
typedef struct lcb_CMDGETREPLICA_ | lcb_CMDGETREPLICA |
typedef struct lcb_RESPEXISTS_ | lcb_RESPEXISTS |
typedef struct lcb_CMDEXISTS_ | lcb_CMDEXISTS |
typedef struct lcb_RESPSTORE_ | lcb_RESPSTORE |
Schedule a single storage request. | |
typedef struct lcb_CMDSTORE_ | lcb_CMDSTORE |
typedef void(* | lcb_open_callback) (lcb_INSTANCE *instance, lcb_STATUS err) |
typedef struct lcb_RESPREMOVE_ | lcb_RESPREMOVE |
Spool a removal of an item. | |
typedef struct lcb_CMDREMOVE_ | lcb_CMDREMOVE |
typedef struct lcb_RESPCOUNTER_ | lcb_RESPCOUNTER |
Schedule single counter operation. | |
typedef struct lcb_CMDCOUNTER_ | lcb_CMDCOUNTER |
typedef struct lcb_RESPUNLOCK_ | lcb_RESPUNLOCK |
Unlock a previously locked item using lcb_cmdunlock. | |
typedef struct lcb_CMDUNLOCK_ | lcb_CMDUNLOCK |
typedef struct lcb_RESPTOUCH_ | lcb_RESPTOUCH |
Spool a touch request. | |
typedef struct lcb_CMDTOUCH_ | lcb_CMDTOUCH |
typedef struct lcb_RESPPING_ | lcb_RESPPING |
typedef struct lcb_CMDPING_ | lcb_CMDPING |
typedef struct lcb_RESPDIAG_ | lcb_RESPDIAG |
typedef struct lcb_CMDDIAG_ | lcb_CMDDIAG |
typedef struct lcb_RESPHTTP_ | lcb_RESPHTTP |
typedef struct lcb_CMDHTTP_ | lcb_CMDHTTP |
typedef void(* | lcb_destroy_callback) (const void *cookie) |
Callback received when instance is about to be destroyed. | |
typedef struct lcb_ANALYTICS_HANDLE_ | lcb_ANALYTICS_HANDLE |
typedef struct lcb_DEFERRED_HANDLE_ | lcb_DEFERRED_HANDLE |
typedef struct lcb_RESPANALYTICS_ | lcb_RESPANALYTICS |
Response for a Analytics query. | |
typedef void(* | lcb_ANALYTICS_CALLBACK) (lcb_INSTANCE *, int, const lcb_RESPANALYTICS *) |
Callback to be invoked for each row. | |
typedef struct lcb_CMDANALYTICS_ | lcb_CMDANALYTICS |
typedef struct lcb_INGEST_OPTIONS_ | lcb_INGEST_OPTIONS |
typedef struct lcb_INGEST_PARAM_ | lcb_INGEST_PARAM |
typedef lcb_INGEST_STATUS(* | lcb_INGEST_DATACONVERTER_CALLBACK) (lcb_INSTANCE *instance, lcb_INGEST_PARAM *param) |
typedef struct lcb_SEARCH_HANDLE_ | lcb_SEARCH_HANDLE |
typedef struct lcb_RESPSEARCH_ | lcb_RESPSEARCH |
typedef struct lcb_CMDSEARCH_ | lcb_CMDSEARCH |
typedef void(* | lcb_SEARCH_CALLBACK) (lcb_INSTANCE *, int, const lcb_RESPSEARCH *) |
typedef struct lcb_RESPQUERY_ | lcb_RESPQUERY |
Opaque query response structure. | |
typedef struct lcb_CMDQUERY_ | lcb_CMDQUERY |
Opaque query command structure. | |
typedef struct lcb_QUERY_HANDLE_ | lcb_QUERY_HANDLE |
Pointer for request instance. | |
typedef void(* | lcb_QUERY_CALLBACK) (lcb_INSTANCE *, int, const lcb_RESPQUERY *) |
Callback to be invoked for each row. | |
typedef struct lcb_RESPVIEW_ | lcb_RESPVIEW |
typedef struct lcb_CMDVIEW_ | lcb_CMDVIEW |
typedef struct lcb_VIEW_HANDLE_ | lcb_VIEW_HANDLE |
Pointer for request instance. | |
typedef void(* | lcb_VIEW_CALLBACK) (lcb_INSTANCE *instance, int cbtype, const lcb_RESPVIEW *row) |
Callback function invoked for each row returned from the view. | |
typedef struct lcb_RESPSUBDOC_ | lcb_RESPSUBDOC |
typedef struct lcb_SUBDOCSPECS_ | lcb_SUBDOCSPECS |
typedef struct lcb_CMDSUBDOC_ | lcb_CMDSUBDOC |
Enumerations | |
enum | lcb_BTYPE |
Type of the bucket. More... | |
enum | lcb_BOOTSTRAP_TRANSPORT |
enum | lcb_INSTANCE_TYPE |
Handle types. More... | |
enum | lcb_RESPFLAGS |
Response flags. More... | |
enum | lcb_CALLBACK_TYPE |
The type of response passed to the callback. More... | |
enum | lcb_DURABILITY_LEVEL |
enum | lcb_REPLICA_MODE |
Spool a single get-with-replica request. More... | |
enum | lcb_REPLICA_READ_PREFERENCE |
enum | lcb_STORE_OPERATION |
Values for lcb_CMDSTORE::operation. More... | |
enum | lcb_PING_STATUS |
Status of the service. More... | |
enum | lcb_PING_SERVICE |
Type of the service. More... | |
enum | lcb_HTTP_TYPE |
The type of HTTP request to execute. More... | |
enum | lcb_HTTP_METHOD |
HTTP Request method enumeration These just enumerate the various types of HTTP request methods supported. More... | |
enum | lcb_WAITFLAGS |
Flags for lcb_wait() More... | |
enum | lcb_VALUEFLAGS |
enum | lcb_INGEST_METHOD |
enum | lcb_ANALYTICS_CONSISTENCY |
enum | lcb_INGEST_STATUS |
enum | lcb_QUERY_CONSISTENCY |
enum | lcb_QUERY_PROFILE |
enum | lcb_SUBDOC_STORE_SEMANTICS |
Functions | |
LIBCOUCHBASE_API lcb_STATUS | lcb_createopts_create (lcb_CREATEOPTS **options, lcb_INSTANCE_TYPE type) |
LIBCOUCHBASE_API lcb_STATUS | lcb_createopts_destroy (lcb_CREATEOPTS *options) |
LIBCOUCHBASE_API lcb_STATUS | lcb_createopts_connstr (lcb_CREATEOPTS *options, const char *connstr, size_t connstr_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_createopts_bucket (lcb_CREATEOPTS *options, const char *bucket, size_t bucket_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_createopts_logger (lcb_CREATEOPTS *options, const lcb_LOGGER *logger) |
LIBCOUCHBASE_API lcb_STATUS | lcb_createopts_credentials (lcb_CREATEOPTS *options, const char *username, size_t username_len, const char *password, size_t password_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_createopts_authenticator (lcb_CREATEOPTS *options, lcb_AUTHENTICATOR *auth) |
LIBCOUCHBASE_API lcb_STATUS | lcb_createopts_io (lcb_CREATEOPTS *options, struct lcb_io_opt_st *io) |
LIBCOUCHBASE_API lcb_STATUS | lcb_createopts_meter (lcb_CREATEOPTS *options, const lcbmetrics_METER *metrics) |
LIBCOUCHBASE_API lcb_STATUS | lcb_createopts_tracer (lcb_CREATEOPTS *options, lcbtrace_TRACER *tracer) |
LIBCOUCHBASE_API lcb_STATUS | lcb_create (lcb_INSTANCE **instance, const lcb_CREATEOPTS *options) |
Create an instance of lcb. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_connect (lcb_INSTANCE *instance) |
Schedule the initial connection This function will schedule the initial connection for the handle. | |
LIBCOUCHBASE_API lcb_bootstrap_callback | lcb_set_bootstrap_callback (lcb_INSTANCE *instance, lcb_bootstrap_callback callback) |
Set the callback for notification of success or failure of initial connection. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_get_bootstrap_status (lcb_INSTANCE *instance) |
Gets the initial bootstrap status. | |
LIBCOUCHBASE_API void | lcb_set_auth (lcb_INSTANCE *instance, lcb_AUTHENTICATOR *auth) |
Sets the authenticator object for the instance. | |
LIBCOUCHBASE_API int | lcb_mutation_token_is_valid (const lcb_MUTATION_TOKEN *token) |
LIBCOUCHBASE_API lcb_RESPCALLBACK | lcb_install_callback (lcb_INSTANCE *instance, int cbtype, lcb_RESPCALLBACK cb) |
LIBCOUCHBASE_API lcb_RESPCALLBACK | lcb_get_callback (lcb_INSTANCE *instance, int cbtype) |
LIBCOUCHBASE_API const char * | lcb_strcbtype (int cbtype) |
Returns the type of the callback as a string. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_respget_status (const lcb_RESPGET *resp) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respget_error_context (const lcb_RESPGET *resp, const lcb_KEY_VALUE_ERROR_CONTEXT **ctx) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respget_cookie (const lcb_RESPGET *resp, void **cookie) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respget_cas (const lcb_RESPGET *resp, uint64_t *cas) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respget_datatype (const lcb_RESPGET *resp, uint8_t *datatype) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respget_flags (const lcb_RESPGET *resp, uint32_t *flags) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respget_key (const lcb_RESPGET *resp, const char **key, size_t *key_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respget_value (const lcb_RESPGET *resp, const char **value, size_t *value_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdget_create (lcb_CMDGET **cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdget_destroy (lcb_CMDGET *cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdget_parent_span (lcb_CMDGET *cmd, lcbtrace_SPAN *span) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdget_collection (lcb_CMDGET *cmd, const char *scope, size_t scope_len, const char *collection, size_t collection_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdget_key (lcb_CMDGET *cmd, const char *key, size_t key_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdget_expiry (lcb_CMDGET *cmd, uint32_t expiration) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdget_locktime (lcb_CMDGET *cmd, uint32_t duration) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdget_timeout (lcb_CMDGET *cmd, uint32_t timeout) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdget_on_behalf_of (lcb_CMDGET *cmd, const char *data, size_t data_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdget_on_behalf_of_extra_privilege (lcb_CMDGET *cmd, const char *privilege, size_t privilege_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_get (lcb_INSTANCE *instance, void *cookie, const lcb_CMDGET *cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respgetreplica_status (const lcb_RESPGETREPLICA *resp) |
LIBCOUCHBASE_API int | lcb_respgetreplica_is_active (const lcb_RESPGETREPLICA *resp) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respgetreplica_error_context (const lcb_RESPGETREPLICA *resp, const lcb_KEY_VALUE_ERROR_CONTEXT **ctx) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respgetreplica_cookie (const lcb_RESPGETREPLICA *resp, void **cookie) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respgetreplica_cas (const lcb_RESPGETREPLICA *resp, uint64_t *cas) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respgetreplica_datatype (const lcb_RESPGETREPLICA *resp, uint8_t *datatype) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respgetreplica_flags (const lcb_RESPGETREPLICA *resp, uint32_t *flags) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respgetreplica_key (const lcb_RESPGETREPLICA *resp, const char **key, size_t *key_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respgetreplica_value (const lcb_RESPGETREPLICA *resp, const char **value, size_t *value_len) |
LIBCOUCHBASE_API int | lcb_respgetreplica_is_final (const lcb_RESPGETREPLICA *resp) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdgetreplica_create (lcb_CMDGETREPLICA **cmd, lcb_REPLICA_MODE mode) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdgetreplica_destroy (lcb_CMDGETREPLICA *cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdgetreplica_parent_span (lcb_CMDGETREPLICA *cmd, lcbtrace_SPAN *span) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdgetreplica_collection (lcb_CMDGETREPLICA *cmd, const char *scope, size_t scope_len, const char *collection, size_t collection_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdgetreplica_key (lcb_CMDGETREPLICA *cmd, const char *key, size_t key_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdgetreplica_timeout (lcb_CMDGETREPLICA *cmd, uint32_t timeout) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdgetreplica_read_preference (lcb_CMDGETREPLICA *cmd, lcb_REPLICA_READ_PREFERENCE preference) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdgetreplica_on_behalf_of (lcb_CMDGETREPLICA *cmd, const char *data, size_t data_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdgetreplica_on_behalf_of_extra_privilege (lcb_CMDGETREPLICA *cmd, const char *privilege, size_t privilege_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_getreplica (lcb_INSTANCE *instance, void *cookie, const lcb_CMDGETREPLICA *cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respexists_status (const lcb_RESPEXISTS *resp) |
LIBCOUCHBASE_API int | lcb_respexists_is_found (const lcb_RESPEXISTS *resp) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respexists_error_context (const lcb_RESPEXISTS *resp, const lcb_KEY_VALUE_ERROR_CONTEXT **ctx) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respexists_cookie (const lcb_RESPEXISTS *resp, void **cookie) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respexists_cas (const lcb_RESPEXISTS *resp, uint64_t *cas) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respexists_key (const lcb_RESPEXISTS *resp, const char **key, size_t *key_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdexists_create (lcb_CMDEXISTS **cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdexists_destroy (lcb_CMDEXISTS *cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdexists_parent_span (lcb_CMDEXISTS *cmd, lcbtrace_SPAN *span) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdexists_collection (lcb_CMDEXISTS *cmd, const char *scope, size_t scope_len, const char *collection, size_t collection_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdexists_key (lcb_CMDEXISTS *cmd, const char *key, size_t key_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdexists_timeout (lcb_CMDEXISTS *cmd, uint32_t timeout) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdexists_on_behalf_of (lcb_CMDEXISTS *cmd, const char *data, size_t data_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdexists_on_behalf_of_extra_privilege (lcb_CMDEXISTS *cmd, const char *privilege, size_t privilege_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_exists (lcb_INSTANCE *instance, void *cookie, const lcb_CMDEXISTS *cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respstore_status (const lcb_RESPSTORE *resp) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respstore_error_context (const lcb_RESPSTORE *resp, const lcb_KEY_VALUE_ERROR_CONTEXT **ctx) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respstore_cookie (const lcb_RESPSTORE *resp, void **cookie) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respstore_cas (const lcb_RESPSTORE *resp, uint64_t *cas) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respstore_key (const lcb_RESPSTORE *resp, const char **key, size_t *key_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respstore_operation (const lcb_RESPSTORE *resp, lcb_STORE_OPERATION *operation) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respstore_mutation_token (const lcb_RESPSTORE *resp, lcb_MUTATION_TOKEN *token) |
LIBCOUCHBASE_API int | lcb_respstore_observe_attached (const lcb_RESPSTORE *resp) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respstore_observe_stored (const lcb_RESPSTORE *resp, int *store_ok) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respstore_observe_master_exists (const lcb_RESPSTORE *resp, int *master_exists) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respstore_observe_master_persisted (const lcb_RESPSTORE *resp, int *master_persisted) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respstore_observe_num_responses (const lcb_RESPSTORE *resp, uint16_t *num_responses) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respstore_observe_num_persisted (const lcb_RESPSTORE *resp, uint16_t *num_persisted) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respstore_observe_num_replicated (const lcb_RESPSTORE *resp, uint16_t *num_replicated) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdstore_create (lcb_CMDSTORE **cmd, lcb_STORE_OPERATION operation) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdstore_destroy (lcb_CMDSTORE *cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdstore_parent_span (lcb_CMDSTORE *cmd, lcbtrace_SPAN *span) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdstore_collection (lcb_CMDSTORE *cmd, const char *scope, size_t scope_len, const char *collection, size_t collection_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdstore_key (lcb_CMDSTORE *cmd, const char *key, size_t key_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdstore_value (lcb_CMDSTORE *cmd, const char *value, size_t value_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdstore_value_iov (lcb_CMDSTORE *cmd, const lcb_IOV *value, size_t value_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdstore_expiry (lcb_CMDSTORE *cmd, uint32_t expiration) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdstore_preserve_expiry (lcb_CMDSTORE *cmd, int should_preserve) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdstore_cas (lcb_CMDSTORE *cmd, uint64_t cas) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdstore_flags (lcb_CMDSTORE *cmd, uint32_t flags) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdstore_datatype (lcb_CMDSTORE *cmd, uint8_t datatype) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdstore_durability (lcb_CMDSTORE *cmd, lcb_DURABILITY_LEVEL level) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdstore_durability_observe (lcb_CMDSTORE *cmd, int persist_to, int replicate_to) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdstore_timeout (lcb_CMDSTORE *cmd, uint32_t timeout) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdstore_on_behalf_of (lcb_CMDSTORE *cmd, const char *data, size_t data_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdstore_on_behalf_of_extra_privilege (lcb_CMDSTORE *cmd, const char *privilege, size_t privilege_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_store (lcb_INSTANCE *instance, void *cookie, const lcb_CMDSTORE *cmd) |
LIBCOUCHBASE_API lcb_open_callback | lcb_set_open_callback (lcb_INSTANCE *instance, lcb_open_callback callback) |
Callback to be called when bucket is opened. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_open (lcb_INSTANCE *instance, const char *bucket, size_t bucket_len) |
Opens bucket. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_respremove_status (const lcb_RESPREMOVE *resp) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respremove_error_context (const lcb_RESPREMOVE *resp, const lcb_KEY_VALUE_ERROR_CONTEXT **ctx) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respremove_cookie (const lcb_RESPREMOVE *resp, void **cookie) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respremove_cas (const lcb_RESPREMOVE *resp, uint64_t *cas) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respremove_key (const lcb_RESPREMOVE *resp, const char **key, size_t *key_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respremove_mutation_token (const lcb_RESPREMOVE *resp, lcb_MUTATION_TOKEN *token) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdremove_create (lcb_CMDREMOVE **cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdremove_destroy (lcb_CMDREMOVE *cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdremove_parent_span (lcb_CMDREMOVE *cmd, lcbtrace_SPAN *span) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdremove_collection (lcb_CMDREMOVE *cmd, const char *scope, size_t scope_len, const char *collection, size_t collection_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdremove_key (lcb_CMDREMOVE *cmd, const char *key, size_t key_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdremove_cas (lcb_CMDREMOVE *cmd, uint64_t cas) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdremove_durability (lcb_CMDREMOVE *cmd, lcb_DURABILITY_LEVEL level) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdremove_timeout (lcb_CMDREMOVE *cmd, uint32_t timeout) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdremove_on_behalf_of (lcb_CMDREMOVE *cmd, const char *data, size_t data_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdremove_on_behalf_of_extra_privilege (lcb_CMDREMOVE *cmd, const char *privilege, size_t privilege_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_remove (lcb_INSTANCE *instance, void *cookie, const lcb_CMDREMOVE *cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respcounter_status (const lcb_RESPCOUNTER *resp) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respcounter_error_context (const lcb_RESPCOUNTER *resp, const lcb_KEY_VALUE_ERROR_CONTEXT **ctx) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respcounter_cookie (const lcb_RESPCOUNTER *resp, void **cookie) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respcounter_cas (const lcb_RESPCOUNTER *resp, uint64_t *cas) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respcounter_key (const lcb_RESPCOUNTER *resp, const char **key, size_t *key_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respcounter_mutation_token (const lcb_RESPCOUNTER *resp, lcb_MUTATION_TOKEN *token) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respcounter_value (const lcb_RESPCOUNTER *resp, uint64_t *value) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdcounter_create (lcb_CMDCOUNTER **cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdcounter_destroy (lcb_CMDCOUNTER *cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdcounter_parent_span (lcb_CMDCOUNTER *cmd, lcbtrace_SPAN *span) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdcounter_collection (lcb_CMDCOUNTER *cmd, const char *scope, size_t scope_len, const char *collection, size_t collection_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdcounter_key (lcb_CMDCOUNTER *cmd, const char *key, size_t key_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdcounter_expiry (lcb_CMDCOUNTER *cmd, uint32_t expiration) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdcounter_delta (lcb_CMDCOUNTER *cmd, int64_t number) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdcounter_initial (lcb_CMDCOUNTER *cmd, uint64_t number) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdcounter_durability (lcb_CMDCOUNTER *cmd, lcb_DURABILITY_LEVEL level) |
LCB_DEPRECATED2 (LIBCOUCHBASE_API lcb_STATUS lcb_cmdcounter_cas(lcb_CMDCOUNTER *cmd, uint64_t cas), "CAS is not applicable to arithmetic operations") | |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdcounter_timeout (lcb_CMDCOUNTER *cmd, uint32_t timeout) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdcounter_on_behalf_of (lcb_CMDCOUNTER *cmd, const char *data, size_t data_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdcounter_on_behalf_of_extra_privilege (lcb_CMDCOUNTER *cmd, const char *privilege, size_t privilege_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_counter (lcb_INSTANCE *instance, void *cookie, const lcb_CMDCOUNTER *cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respunlock_status (const lcb_RESPUNLOCK *resp) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respunlock_error_context (const lcb_RESPUNLOCK *resp, const lcb_KEY_VALUE_ERROR_CONTEXT **ctx) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respunlock_cookie (const lcb_RESPUNLOCK *resp, void **cookie) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respunlock_cas (const lcb_RESPUNLOCK *resp, uint64_t *cas) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respunlock_key (const lcb_RESPUNLOCK *resp, const char **key, size_t *key_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdunlock_create (lcb_CMDUNLOCK **cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdunlock_destroy (lcb_CMDUNLOCK *cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdunlock_parent_span (lcb_CMDUNLOCK *cmd, lcbtrace_SPAN *span) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdunlock_collection (lcb_CMDUNLOCK *cmd, const char *scope, size_t scope_len, const char *collection, size_t collection_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdunlock_key (lcb_CMDUNLOCK *cmd, const char *key, size_t key_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdunlock_cas (lcb_CMDUNLOCK *cmd, uint64_t cas) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdunlock_timeout (lcb_CMDUNLOCK *cmd, uint32_t timeout) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdunlock_on_behalf_of (lcb_CMDUNLOCK *cmd, const char *data, size_t data_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdunlock_on_behalf_of_extra_privilege (lcb_CMDUNLOCK *cmd, const char *privilege, size_t privilege_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_unlock (lcb_INSTANCE *instance, void *cookie, const lcb_CMDUNLOCK *cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_resptouch_status (const lcb_RESPTOUCH *resp) |
LIBCOUCHBASE_API lcb_STATUS | lcb_resptouch_error_context (const lcb_RESPTOUCH *resp, const lcb_KEY_VALUE_ERROR_CONTEXT **ctx) |
LIBCOUCHBASE_API lcb_STATUS | lcb_resptouch_cookie (const lcb_RESPTOUCH *resp, void **cookie) |
LIBCOUCHBASE_API lcb_STATUS | lcb_resptouch_cas (const lcb_RESPTOUCH *resp, uint64_t *cas) |
LIBCOUCHBASE_API lcb_STATUS | lcb_resptouch_key (const lcb_RESPTOUCH *resp, const char **key, size_t *key_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_resptouch_mutation_token (const lcb_RESPTOUCH *resp, lcb_MUTATION_TOKEN *token) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdtouch_create (lcb_CMDTOUCH **cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdtouch_destroy (lcb_CMDTOUCH *cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdtouch_parent_span (lcb_CMDTOUCH *cmd, lcbtrace_SPAN *span) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdtouch_collection (lcb_CMDTOUCH *cmd, const char *scope, size_t scope_len, const char *collection, size_t collection_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdtouch_key (lcb_CMDTOUCH *cmd, const char *key, size_t key_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdtouch_expiry (lcb_CMDTOUCH *cmd, uint32_t expiration) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdtouch_durability (lcb_CMDTOUCH *cmd, lcb_DURABILITY_LEVEL level) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdtouch_timeout (lcb_CMDTOUCH *cmd, uint32_t timeout) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdtouch_on_behalf_of (lcb_CMDTOUCH *cmd, const char *data, size_t data_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdtouch_on_behalf_of_extra_privilege (lcb_CMDTOUCH *cmd, const char *privilege, size_t privilege_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_touch (lcb_INSTANCE *instance, void *cookie, const lcb_CMDTOUCH *cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respping_status (const lcb_RESPPING *resp) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respping_cookie (const lcb_RESPPING *resp, void **cookie) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respping_value (const lcb_RESPPING *resp, const char **json, size_t *json_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respping_report_id (const lcb_RESPPING *resp, const char **report_id, size_t *report_id_len) |
LIBCOUCHBASE_API size_t | lcb_respping_result_size (const lcb_RESPPING *resp) |
LIBCOUCHBASE_API lcb_PING_STATUS | lcb_respping_result_status (const lcb_RESPPING *resp, size_t index) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respping_result_id (const lcb_RESPPING *resp, size_t index, const char **endpoint_id, size_t *endpoint_id_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respping_result_service (const lcb_RESPPING *resp, size_t index, lcb_PING_SERVICE *type) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respping_result_remote (const lcb_RESPPING *resp, size_t index, const char **address, size_t *address_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respping_result_local (const lcb_RESPPING *resp, size_t index, const char **address, size_t *address_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respping_result_latency (const lcb_RESPPING *resp, size_t index, uint64_t *latency) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respping_result_namespace (const lcb_RESPPING *resp, size_t index, const char **name, size_t *name_len) |
LCB_DEPRECATED2 (LIBCOUCHBASE_API lcb_STATUS lcb_respping_result_scope(const lcb_RESPPING *resp, size_t index, const char **name, size_t *name_len), "Use lcb_respping_result_namespace") | |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdping_create (lcb_CMDPING **cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdping_destroy (lcb_CMDPING *cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdping_parent_span (lcb_CMDPING *cmd, lcbtrace_SPAN *span) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdping_report_id (lcb_CMDPING *cmd, const char *report_id, size_t report_id_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdping_all (lcb_CMDPING *cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdping_kv (lcb_CMDPING *cmd, int enable) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdping_query (lcb_CMDPING *cmd, int enable) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdping_views (lcb_CMDPING *cmd, int enable) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdping_search (lcb_CMDPING *cmd, int enable) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdping_analytics (lcb_CMDPING *cmd, int enable) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdping_no_metrics (lcb_CMDPING *cmd, int enable) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdping_encode_json (lcb_CMDPING *cmd, int enable, int pretty, int with_details) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdping_timeout (lcb_CMDPING *cmd, uint32_t timeout) |
LIBCOUCHBASE_API lcb_STATUS | lcb_ping (lcb_INSTANCE *instance, void *cookie, const lcb_CMDPING *cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respdiag_status (const lcb_RESPDIAG *resp) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respdiag_cookie (const lcb_RESPDIAG *resp, void **cookie) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respdiag_value (const lcb_RESPDIAG *resp, const char **json, size_t *json_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmddiag_create (lcb_CMDDIAG **cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmddiag_destroy (lcb_CMDDIAG *cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmddiag_report_id (lcb_CMDDIAG *cmd, const char *report_id, size_t report_id_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmddiag_prettify (lcb_CMDDIAG *cmd, int enable) |
LIBCOUCHBASE_API lcb_STATUS | lcb_diag (lcb_INSTANCE *instance, void *cookie, const lcb_CMDDIAG *cmd) |
Returns diagnostics report about network connections. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_resphttp_status (const lcb_RESPHTTP *resp) |
LIBCOUCHBASE_API lcb_STATUS | lcb_resphttp_cookie (const lcb_RESPHTTP *resp, void **cookie) |
LIBCOUCHBASE_API lcb_STATUS | lcb_resphttp_http_status (const lcb_RESPHTTP *resp, uint16_t *status) |
LIBCOUCHBASE_API lcb_STATUS | lcb_resphttp_path (const lcb_RESPHTTP *resp, const char **path, size_t *path_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_resphttp_body (const lcb_RESPHTTP *resp, const char **body, size_t *body_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_resphttp_handle (const lcb_RESPHTTP *resp, lcb_HTTP_HANDLE **handle) |
LIBCOUCHBASE_API lcb_STATUS | lcb_resphttp_error_context (const lcb_RESPHTTP *resp, const lcb_HTTP_ERROR_CONTEXT **ctx) |
LIBCOUCHBASE_API int | lcb_resphttp_is_final (const lcb_RESPHTTP *resp) |
LIBCOUCHBASE_API lcb_STATUS | lcb_resphttp_headers (const lcb_RESPHTTP *resp, const char *const **headers) |
List of key-value headers. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdhttp_create (lcb_CMDHTTP **cmd, lcb_HTTP_TYPE type) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdhttp_destroy (lcb_CMDHTTP *cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdhttp_parent_span (lcb_CMDHTTP *cmd, lcbtrace_SPAN *span) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdhttp_method (lcb_CMDHTTP *cmd, lcb_HTTP_METHOD method) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdhttp_path (lcb_CMDHTTP *cmd, const char *path, size_t path_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdhttp_content_type (lcb_CMDHTTP *cmd, const char *content_type, size_t content_type_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdhttp_body (lcb_CMDHTTP *cmd, const char *body, size_t body_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdhttp_handle (lcb_CMDHTTP *cmd, lcb_HTTP_HANDLE **handle) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdhttp_username (lcb_CMDHTTP *cmd, const char *username, size_t username_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdhttp_password (lcb_CMDHTTP *cmd, const char *password, size_t password_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdhttp_host (lcb_CMDHTTP *cmd, const char *host, size_t host_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdhttp_streaming (lcb_CMDHTTP *cmd, int streaming) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdhttp_skip_auth_header (lcb_CMDHTTP *cmd, int skip_auth) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdhttp_timeout (lcb_CMDHTTP *cmd, uint32_t timeout) |
LIBCOUCHBASE_API lcb_STATUS | lcb_http (lcb_INSTANCE *instance, void *cookie, const lcb_CMDHTTP *cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_http_cancel (lcb_INSTANCE *instance, lcb_HTTP_HANDLE *handle) |
Cancel ongoing HTTP request. | |
LIBCOUCHBASE_API void | lcb_set_cookie (lcb_INSTANCE *instance, const void *cookie) |
Associate a cookie with an instance of lcb. | |
LIBCOUCHBASE_API const void * | lcb_get_cookie (lcb_INSTANCE *instance) |
Retrieve the cookie associated with this instance. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_tick_nowait (lcb_INSTANCE *instance) |
LIBCOUCHBASE_API lcb_STATUS | lcb_wait (lcb_INSTANCE *instance, lcb_WAITFLAGS flags) |
Wait for completion of scheduled operations. | |
LIBCOUCHBASE_API void | lcb_breakout (lcb_INSTANCE *instance) |
Forcefully break from the event loop. | |
LIBCOUCHBASE_API int | lcb_is_waiting (lcb_INSTANCE *instance) |
Check if instance is blocked in the event loop. | |
LIBCOUCHBASE_API void | lcb_sched_enter (lcb_INSTANCE *instance) |
Enter a scheduling context. | |
LIBCOUCHBASE_API void | lcb_sched_leave (lcb_INSTANCE *instance) |
Leave the current scheduling context, scheduling the commands within the context to be flushed to the network. | |
LIBCOUCHBASE_API void | lcb_sched_fail (lcb_INSTANCE *instance) |
Fail all commands in the current scheduling context. | |
LIBCOUCHBASE_API void | lcb_sched_flush (lcb_INSTANCE *instance) |
Request commands to be flushed to the network. | |
LIBCOUCHBASE_API void | lcb_destroy (lcb_INSTANCE *instance) |
Destroy (and release all allocated resources) an instance of lcb. | |
LIBCOUCHBASE_API lcb_destroy_callback | lcb_set_destroy_callback (lcb_INSTANCE *instance, lcb_destroy_callback) |
Set the callback to be invoked when the instance is destroyed asynchronously. | |
LIBCOUCHBASE_API void | lcb_destroy_async (lcb_INSTANCE *instance, const void *arg) |
Asynchronously schedule the destruction of an instance. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_cntl (lcb_INSTANCE *instance, int mode, int cmd, void *arg) |
This function exposes an ioctl/fcntl-like interface to read and write various configuration properties to and from an lcb_INSTANCE *handle. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_cntl_string (lcb_INSTANCE *instance, const char *key, const char *value) |
Alternatively one may change configuration settings by passing a string key and value. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_cntl_setu32 (lcb_INSTANCE *instance, int cmd, lcb_U32 arg) |
Convenience function to set a value as an lcb_U32. | |
LIBCOUCHBASE_API lcb_U32 | lcb_cntl_getu32 (lcb_INSTANCE *instance, int cmd) |
Retrieve an lcb_U32 setting. | |
LIBCOUCHBASE_API int | lcb_cntl_exists (int ctl) |
Determine if a specific control code exists. | |
LIBCOUCHBASE_API void | lcb_refresh_config (lcb_INSTANCE *instance) |
Force the library to refetch the cluster configuration. | |
LIBCOUCHBASE_API const char * | lcb_get_version (lcb_U32 *version) |
Get the version of the library. | |
LIBCOUCHBASE_API int | lcb_supports_feature (int n) |
LIBCOUCHBASE_API int | lcb_is_redacting_logs (lcb_INSTANCE *instance) |
Returns whether the library redacting logs for this connection instance. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_respanalytics_status (const lcb_RESPANALYTICS *resp) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respanalytics_cookie (const lcb_RESPANALYTICS *resp, void **cookie) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respanalytics_row (const lcb_RESPANALYTICS *resp, const char **row, size_t *row_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respanalytics_http_response (const lcb_RESPANALYTICS *resp, const lcb_RESPHTTP **http) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respanalytics_handle (const lcb_RESPANALYTICS *resp, lcb_ANALYTICS_HANDLE **handle) |
Get handle to analytics query. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_respanalytics_error_context (const lcb_RESPANALYTICS *resp, const lcb_ANALYTICS_ERROR_CONTEXT **ctx) |
LIBCOUCHBASE_API int | lcb_respanalytics_is_final (const lcb_RESPANALYTICS *resp) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respanalytics_deferred_handle_extract (const lcb_RESPANALYTICS *resp, lcb_DEFERRED_HANDLE **handle) |
LIBCOUCHBASE_API lcb_STATUS | lcb_deferred_handle_destroy (lcb_DEFERRED_HANDLE *handle) |
LIBCOUCHBASE_API lcb_STATUS | lcb_deferred_handle_status (lcb_DEFERRED_HANDLE *handle, const char **status, size_t *status_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_deferred_handle_callback (lcb_DEFERRED_HANDLE *handle, lcb_ANALYTICS_CALLBACK callback) |
LIBCOUCHBASE_API lcb_STATUS | lcb_deferred_handle_poll (lcb_INSTANCE *instance, void *cookie, lcb_DEFERRED_HANDLE *handle) |
LIBCOUCHBASE_API lcb_STATUS | lcb_ingest_options_create (lcb_INGEST_OPTIONS **options) |
LIBCOUCHBASE_API lcb_STATUS | lcb_ingest_options_destroy (lcb_INGEST_OPTIONS *options) |
LIBCOUCHBASE_API lcb_STATUS | lcb_ingest_options_method (lcb_INGEST_OPTIONS *options, lcb_INGEST_METHOD method) |
LIBCOUCHBASE_API lcb_STATUS | lcb_ingest_options_expiry (lcb_INGEST_OPTIONS *options, uint32_t expiration) |
LIBCOUCHBASE_API lcb_STATUS | lcb_ingest_options_ignore_error (lcb_INGEST_OPTIONS *options, int flag) |
LIBCOUCHBASE_API lcb_STATUS | lcb_ingest_options_data_converter (lcb_INGEST_OPTIONS *options, lcb_INGEST_DATACONVERTER_CALLBACK callback) |
LIBCOUCHBASE_API lcb_STATUS | lcb_ingest_dataconverter_param_cookie (lcb_INGEST_PARAM *param, void **cookie) |
LIBCOUCHBASE_API lcb_STATUS | lcb_ingest_dataconverter_param_row (lcb_INGEST_PARAM *param, const char **row, size_t *row_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_ingest_dataconverter_param_method (lcb_INGEST_PARAM *param, lcb_INGEST_METHOD *method) |
LIBCOUCHBASE_API lcb_STATUS | lcb_ingest_dataconverter_param_set_id (lcb_INGEST_PARAM *param, const char *id, size_t id_len, void(*id_dtor)(const char *)) |
LIBCOUCHBASE_API lcb_STATUS | lcb_ingest_dataconverter_param_set_out (lcb_INGEST_PARAM *param, const char *out, size_t out_len, void(*out_dtor)(const char *)) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdanalytics_create (lcb_CMDANALYTICS **cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdanalytics_destroy (lcb_CMDANALYTICS *cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdanalytics_reset (lcb_CMDANALYTICS *cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdanalytics_parent_span (lcb_CMDANALYTICS *cmd, lcbtrace_SPAN *span) |
Associate parent tracing span with the Analytics request. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdanalytics_callback (lcb_CMDANALYTICS *cmd, lcb_ANALYTICS_CALLBACK callback) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdanalytics_encoded_payload (lcb_CMDANALYTICS *cmd, const char **query, size_t *query_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdanalytics_payload (lcb_CMDANALYTICS *cmd, const char *query, size_t query_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdanalytics_statement (lcb_CMDANALYTICS *cmd, const char *statement, size_t statement_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdanalytics_named_param (lcb_CMDANALYTICS *cmd, const char *name, size_t name_len, const char *value, size_t value_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdanalytics_positional_params (lcb_CMDANALYTICS *cmd, const char *value, size_t value_len) |
Sets the positional arguments for the query. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdanalytics_positional_param (lcb_CMDANALYTICS *cmd, const char *value, size_t value_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdanalytics_ingest_options (lcb_CMDANALYTICS *cmd, lcb_INGEST_OPTIONS *options) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdanalytics_deferred (lcb_CMDANALYTICS *cmd, int deferred) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdanalytics_client_context_id (lcb_CMDANALYTICS *cmd, const char *value, size_t value_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdanalytics_readonly (lcb_CMDANALYTICS *cmd, int readonly) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdanalytics_priority (lcb_CMDANALYTICS *cmd, int priority) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdanalytics_consistency (lcb_CMDANALYTICS *cmd, lcb_ANALYTICS_CONSISTENCY level) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdanalytics_option (lcb_CMDANALYTICS *cmd, const char *name, size_t name_len, const char *value, size_t value_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdanalytics_scope_name (lcb_CMDANALYTICS *cmd, const char *scope, size_t scope_len) |
Associate scope name with the query. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdanalytics_scope_qualifier (lcb_CMDANALYTICS *cmd, const char *qualifier, size_t qualifier_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdanalytics_handle (lcb_CMDANALYTICS *cmd, lcb_ANALYTICS_HANDLE **handle) |
Get handle to analytics query. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdanalytics_timeout (lcb_CMDANALYTICS *cmd, uint32_t timeout) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdanalytics_on_behalf_of (lcb_CMDANALYTICS *cmd, const char *data, size_t data_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_analytics (lcb_INSTANCE *instance, void *cookie, const lcb_CMDANALYTICS *cmd) |
Execute a Analytics query. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_analytics_cancel (lcb_INSTANCE *instance, lcb_ANALYTICS_HANDLE *handle) |
Cancels an in-progress request. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_respsearch_status (const lcb_RESPSEARCH *resp) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respsearch_cookie (const lcb_RESPSEARCH *resp, void **cookie) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respsearch_row (const lcb_RESPSEARCH *resp, const char **row, size_t *row_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respsearch_http_response (const lcb_RESPSEARCH *resp, const lcb_RESPHTTP **http) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respsearch_handle (const lcb_RESPSEARCH *resp, lcb_SEARCH_HANDLE **handle) |
Get search handle from search response. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_respsearch_error_context (const lcb_RESPSEARCH *resp, const lcb_SEARCH_ERROR_CONTEXT **ctx) |
LIBCOUCHBASE_API int | lcb_respsearch_is_final (const lcb_RESPSEARCH *resp) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdsearch_create (lcb_CMDSEARCH **cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdsearch_destroy (lcb_CMDSEARCH *cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdsearch_parent_span (lcb_CMDSEARCH *cmd, lcbtrace_SPAN *span) |
Associate parent tracing span with the FTS request. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdsearch_callback (lcb_CMDSEARCH *cmd, lcb_SEARCH_CALLBACK callback) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdsearch_payload (lcb_CMDSEARCH *cmd, const char *payload, size_t payload_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdsearch_handle (lcb_CMDSEARCH *cmd, lcb_SEARCH_HANDLE **handle) |
Obtain handle to search. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdsearch_timeout (lcb_CMDSEARCH *cmd, uint32_t timeout) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdsearch_on_behalf_of (lcb_CMDSEARCH *cmd, const char *data, size_t data_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_search (lcb_INSTANCE *instance, void *cookie, const lcb_CMDSEARCH *cmd) |
Issue a full-text query. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_search_cancel (lcb_INSTANCE *instance, lcb_SEARCH_HANDLE *handle) |
Cancel a full-text query in progress. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_respquery_status (const lcb_RESPQUERY *resp) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respquery_cookie (const lcb_RESPQUERY *resp, void **cookie) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respquery_row (const lcb_RESPQUERY *resp, const char **row, size_t *row_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respquery_http_response (const lcb_RESPQUERY *resp, const lcb_RESPHTTP **http) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respquery_handle (const lcb_RESPQUERY *resp, lcb_QUERY_HANDLE **handle) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respquery_error_context (const lcb_RESPQUERY *resp, const lcb_QUERY_ERROR_CONTEXT **ctx) |
LIBCOUCHBASE_API int | lcb_respquery_is_final (const lcb_RESPQUERY *resp) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdquery_create (lcb_CMDQUERY **cmd) |
Create a new lcb_CMDQUERY object. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdquery_destroy (lcb_CMDQUERY *cmd) |
Free the command structure. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdquery_reset (lcb_CMDQUERY *cmd) |
Reset the lcb_CMDQUERY structure so that it may be reused for a subsequent query. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdquery_encoded_payload (lcb_CMDQUERY *cmd, const char **payload, size_t *payload_len) |
Get the JSON-encoded query payload. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdquery_parent_span (lcb_CMDQUERY *cmd, lcbtrace_SPAN *span) |
Associate parent tracing span with the N1QL request. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdquery_callback (lcb_CMDQUERY *cmd, lcb_QUERY_CALLBACK callback) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdquery_payload (lcb_CMDQUERY *cmd, const char *query, size_t query_len) |
Sets the JSON-encodes query payload to be executed. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdquery_statement (lcb_CMDQUERY *cmd, const char *statement, size_t statement_len) |
Sets the actual statement to be executed. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdquery_scope_name (lcb_CMDQUERY *cmd, const char *scope, size_t scope_len) |
Associate scope name with the query. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdquery_scope_qualifier (lcb_CMDQUERY *cmd, const char *qualifier, size_t qualifier_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdquery_named_param (lcb_CMDQUERY *cmd, const char *name, size_t name_len, const char *value, size_t value_len) |
Sets a named argument for the query. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdquery_positional_params (lcb_CMDQUERY *cmd, const char *value, size_t value_len) |
Sets the positional arguments for the query. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdquery_positional_param (lcb_CMDQUERY *cmd, const char *value, size_t value_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdquery_adhoc (lcb_CMDQUERY *cmd, int adhoc) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdquery_client_context_id (lcb_CMDQUERY *cmd, const char *value, size_t value_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdquery_pretty (lcb_CMDQUERY *cmd, int pretty) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdquery_readonly (lcb_CMDQUERY *cmd, int readonly) |
Marks query as read-only. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdquery_metrics (lcb_CMDQUERY *cmd, int metrics) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdquery_scan_cap (lcb_CMDQUERY *cmd, int value) |
Sets maximum buffered channel size between the indexer client and the query service for index scans. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdquery_scan_wait (lcb_CMDQUERY *cmd, uint32_t us) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdquery_flex_index (lcb_CMDQUERY *cmd, int value) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdquery_profile (lcb_CMDQUERY *cmd, lcb_QUERY_PROFILE mode) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdquery_pipeline_cap (lcb_CMDQUERY *cmd, int value) |
Sets maximum number of items each execution operator can buffer between various operators. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdquery_pipeline_batch (lcb_CMDQUERY *cmd, int value) |
Sets the number of items execution operators can batch for fetch from the KV. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdquery_max_parallelism (lcb_CMDQUERY *cmd, int value) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdquery_consistency (lcb_CMDQUERY *cmd, lcb_QUERY_CONSISTENCY mode) |
Sets the consistency mode for the request. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdquery_consistency_token_for_keyspace (lcb_CMDQUERY *cmd, const char *keyspace, size_t keyspace_len, const lcb_MUTATION_TOKEN *token) |
Indicate that the query should synchronize its internal snapshot to reflect the changes indicated by the given mutation token (ss ). | |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdquery_consistency_tokens (lcb_CMDQUERY *cmd, lcb_INSTANCE *instance) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdquery_option (lcb_CMDQUERY *cmd, const char *name, size_t name_len, const char *value, size_t value_len) |
Set a query option. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdquery_handle (lcb_CMDQUERY *cmd, lcb_QUERY_HANDLE **handle) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdquery_timeout (lcb_CMDQUERY *cmd, uint32_t timeout) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdquery_preserve_expiry (lcb_CMDQUERY *cmd, int preserve_expiry) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdquery_on_behalf_of (lcb_CMDQUERY *cmd, const char *data, size_t data_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_query (lcb_INSTANCE *instance, void *cookie, const lcb_CMDQUERY *cmd) |
Execute a N1QL query. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_query_cancel (lcb_INSTANCE *instance, lcb_QUERY_HANDLE *handle) |
Cancels an in-progress request. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_respview_status (const lcb_RESPVIEW *resp) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respview_cookie (const lcb_RESPVIEW *resp, void **cookie) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respview_key (const lcb_RESPVIEW *resp, const char **key, size_t *key_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respview_doc_id (const lcb_RESPVIEW *resp, const char **doc_id, size_t *doc_id_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respview_row (const lcb_RESPVIEW *resp, const char **row, size_t *row_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respview_document (const lcb_RESPVIEW *resp, const lcb_RESPGET **doc) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respview_http_response (const lcb_RESPVIEW *resp, const lcb_RESPHTTP **http) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respview_handle (const lcb_RESPVIEW *resp, lcb_VIEW_HANDLE **handle) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respview_error_context (const lcb_RESPVIEW *resp, const lcb_VIEW_ERROR_CONTEXT **ctx) |
LIBCOUCHBASE_API int | lcb_respview_is_final (const lcb_RESPVIEW *resp) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdview_create (lcb_CMDVIEW **cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdview_destroy (lcb_CMDVIEW *cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdview_parent_span (lcb_CMDVIEW *cmd, lcbtrace_SPAN *span) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdview_callback (lcb_CMDVIEW *cmd, lcb_VIEW_CALLBACK callback) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdview_design_document (lcb_CMDVIEW *cmd, const char *ddoc, size_t ddoc_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdview_view_name (lcb_CMDVIEW *cmd, const char *view, size_t view_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdview_option_string (lcb_CMDVIEW *cmd, const char *optstr, size_t optstr_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdview_post_data (lcb_CMDVIEW *cmd, const char *data, size_t data_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdview_include_docs (lcb_CMDVIEW *cmd, int include_docs) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdview_max_concurrent_docs (lcb_CMDVIEW *cmd, uint32_t num) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdview_no_row_parse (lcb_CMDVIEW *cmd, int flag) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdview_handle (lcb_CMDVIEW *cmd, lcb_VIEW_HANDLE **handle) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdview_timeout (lcb_CMDVIEW *cmd, uint32_t timeout) |
LIBCOUCHBASE_API lcb_STATUS | lcb_view (lcb_INSTANCE *instance, void *cookie, const lcb_CMDVIEW *cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_view_cancel (lcb_INSTANCE *instance, lcb_VIEW_HANDLE *handle) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respsubdoc_status (const lcb_RESPSUBDOC *resp) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respsubdoc_error_context (const lcb_RESPSUBDOC *resp, const lcb_KEY_VALUE_ERROR_CONTEXT **ctx) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respsubdoc_cookie (const lcb_RESPSUBDOC *resp, void **cookie) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respsubdoc_cas (const lcb_RESPSUBDOC *resp, uint64_t *cas) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respsubdoc_key (const lcb_RESPSUBDOC *resp, const char **key, size_t *key_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respsubdoc_mutation_token (const lcb_RESPSUBDOC *resp, lcb_MUTATION_TOKEN *token) |
LIBCOUCHBASE_API size_t | lcb_respsubdoc_result_size (const lcb_RESPSUBDOC *resp) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respsubdoc_result_status (const lcb_RESPSUBDOC *resp, size_t index) |
LIBCOUCHBASE_API lcb_STATUS | lcb_respsubdoc_result_value (const lcb_RESPSUBDOC *resp, size_t index, const char **value, size_t *value_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_subdocspecs_create (lcb_SUBDOCSPECS **operations, size_t capacity) |
LIBCOUCHBASE_API lcb_STATUS | lcb_subdocspecs_destroy (lcb_SUBDOCSPECS *operations) |
LIBCOUCHBASE_API lcb_STATUS | lcb_subdocspecs_get (lcb_SUBDOCSPECS *operations, size_t index, uint32_t flags, const char *path, size_t path_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_subdocspecs_exists (lcb_SUBDOCSPECS *operations, size_t index, uint32_t flags, const char *path, size_t path_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_subdocspecs_replace (lcb_SUBDOCSPECS *operations, size_t index, uint32_t flags, const char *path, size_t path_len, const char *value, size_t value_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_subdocspecs_dict_add (lcb_SUBDOCSPECS *operations, size_t index, uint32_t flags, const char *path, size_t path_len, const char *value, size_t value_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_subdocspecs_dict_upsert (lcb_SUBDOCSPECS *operations, size_t index, uint32_t flags, const char *path, size_t path_len, const char *value, size_t value_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_subdocspecs_array_add_first (lcb_SUBDOCSPECS *operations, size_t index, uint32_t flags, const char *path, size_t path_len, const char *value, size_t value_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_subdocspecs_array_add_last (lcb_SUBDOCSPECS *operations, size_t index, uint32_t flags, const char *path, size_t path_len, const char *value, size_t value_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_subdocspecs_array_add_unique (lcb_SUBDOCSPECS *operations, size_t index, uint32_t flags, const char *path, size_t path_len, const char *value, size_t value_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_subdocspecs_array_insert (lcb_SUBDOCSPECS *operations, size_t index, uint32_t flags, const char *path, size_t path_len, const char *value, size_t value_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_subdocspecs_counter (lcb_SUBDOCSPECS *operations, size_t index, uint32_t flags, const char *path, size_t path_len, int64_t delta) |
LIBCOUCHBASE_API lcb_STATUS | lcb_subdocspecs_remove (lcb_SUBDOCSPECS *operations, size_t index, uint32_t flags, const char *path, size_t path_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_subdocspecs_get_count (lcb_SUBDOCSPECS *operations, size_t index, uint32_t flags, const char *path, size_t path_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdsubdoc_create (lcb_CMDSUBDOC **cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdsubdoc_destroy (lcb_CMDSUBDOC *cmd) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdsubdoc_parent_span (lcb_CMDSUBDOC *cmd, lcbtrace_SPAN *span) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdsubdoc_collection (lcb_CMDSUBDOC *cmd, const char *scope, size_t scope_len, const char *collection, size_t collection_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdsubdoc_key (lcb_CMDSUBDOC *cmd, const char *key, size_t key_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdsubdoc_cas (lcb_CMDSUBDOC *cmd, uint64_t cas) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdsubdoc_specs (lcb_CMDSUBDOC *cmd, const lcb_SUBDOCSPECS *operations) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdsubdoc_expiry (lcb_CMDSUBDOC *cmd, uint32_t expiration) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdsubdoc_preserve_expiry (lcb_CMDSUBDOC *cmd, int should_preserve) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdsubdoc_durability (lcb_CMDSUBDOC *cmd, lcb_DURABILITY_LEVEL level) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdsubdoc_store_semantics (lcb_CMDSUBDOC *cmd, lcb_SUBDOC_STORE_SEMANTICS mode) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdsubdoc_access_deleted (lcb_CMDSUBDOC *cmd, int flag) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdsubdoc_create_as_deleted (lcb_CMDSUBDOC *cmd, int flag) |
If new document created, the server will create it as a tombstone. | |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdsubdoc_timeout (lcb_CMDSUBDOC *cmd, uint32_t timeout) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdsubdoc_on_behalf_of (lcb_CMDSUBDOC *cmd, const char *data, size_t data_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_cmdsubdoc_on_behalf_of_extra_privilege (lcb_CMDSUBDOC *cmd, const char *privilege, size_t privilege_len) |
LIBCOUCHBASE_API lcb_STATUS | lcb_subdoc (lcb_INSTANCE *instance, void *cookie, const lcb_CMDSUBDOC *cmd) |
Variables | |
LIBCOUCHBASE_API LCB_EXTERN_VAR const lcb_U32 | lcb_version_g |
Global/extern variable containing the version of the library. | |
Main header file for Couchbase.
#define LCB_DATATYPE_JSON |
#define LCB_SUBDOCSPECS_F_XATTR_MACROVALUES |
Access document virtual/materialized path.
Implies F_XATTRPATH
typedef struct lcb_RESPTOUCH_ lcb_RESPTOUCH |
Spool a touch request.
instance | the handle |
cookie | the pointer to associate with the request |
cmd | the command |
typedef struct lcb_RESPHTTP_ lcb_RESPHTTP |
instance | the library handle |
cookie | cookie to be associated with the request |
cmd | the command |
typedef void(* lcb_destroy_callback) (const void *cookie) |
Callback received when instance is about to be destroyed.
cookie | cookie passed to lcb_destroy_async() |
enum lcb_HTTP_TYPE |
The type of HTTP request to execute.
Enumerator | |
---|---|
LCB_HTTP_TYPE_VIEW | Execute a request against the bucket. The handle must be of LCB_TYPE_BUCKET and must be connected. |
LCB_HTTP_TYPE_MANAGEMENT | Execute a management API request. The credentials used will match those passed during the instance creation time. Thus is the instance type is LCB_TYPE_BUCKET then only bucket-level credentials will be used. |
LCB_HTTP_TYPE_RAW | Execute an arbitrary request against a host and port. |
LCB_HTTP_TYPE_QUERY | Execute an N1QL Query. |
LCB_HTTP_TYPE_SEARCH | Search a fulltext index. |
LCB_HTTP_TYPE_ANALYTICS | Execute an Analytics Query. |
LCB_HTTP_TYPE_PING | Special pseudo-type, for ping endpoints in various services. Behaves like RAW (the lcb_ping3() function will setup custom path), but supports Keep-Alive |
enum lcb_HTTP_METHOD |
HTTP Request method enumeration These just enumerate the various types of HTTP request methods supported.
Refer to the specific cluster or view API to see which method is appropriate for your request
enum lcb_VALUEFLAGS |
LIBCOUCHBASE_API lcb_STATUS lcb_cmdtouch_on_behalf_of | ( | lcb_CMDTOUCH * | cmd, |
const char * | data, | ||
size_t | data_len ) |
LIBCOUCHBASE_API lcb_STATUS lcb_cmdtouch_on_behalf_of_extra_privilege | ( | lcb_CMDTOUCH * | cmd, |
const char * | privilege, | ||
size_t | privilege_len ) |
LIBCOUCHBASE_API lcb_STATUS lcb_resphttp_headers | ( | const lcb_RESPHTTP * | resp, |
const char *const ** | headers ) |
List of key-value headers.
This field itself may be NULL
. The list is terminated by a NULL
pointer to indicate no more headers.
LIBCOUCHBASE_API lcb_STATUS lcb_http_cancel | ( | lcb_INSTANCE * | instance, |
lcb_HTTP_HANDLE * | handle ) |
Cancel ongoing HTTP request.
This API will stop the current request. Any pending callbacks will not be invoked any any pending data will not be delivered. Useful for a long running request which is no longer needed
instance | The handle to lcb |
handle | The request handle |
LIBCOUCHBASE_API void lcb_destroy | ( | lcb_INSTANCE * | instance | ) |
Destroy (and release all allocated resources) an instance of lcb.
Using instance after calling destroy will most likely cause your application to crash.
Note that any pending operations will not have their callbacks invoked.
instance | the instance to destroy. |
LIBCOUCHBASE_API lcb_destroy_callback lcb_set_destroy_callback | ( | lcb_INSTANCE * | instance, |
lcb_destroy_callback | ) |
Set the callback to be invoked when the instance is destroyed asynchronously.
LIBCOUCHBASE_API void lcb_destroy_async | ( | lcb_INSTANCE * | instance, |
const void * | arg ) |
Asynchronously schedule the destruction of an instance.
This function provides a safe way for asynchronous environments to destroy the lcb_INSTANCE *handle without worrying about reentrancy issues.
instance | |
arg | a pointer passed to the callback. |
While the callback and cookie are optional, they are very much recommended for testing scenarios where you wish to ensure that all resources allocated by the instance have been closed. Specifically when the callback is invoked, all timers (save for the one actually triggering the destruction) and sockets will have been closed.
As with lcb_destroy() you may call this function only once. You may not call this function together with lcb_destroy as the two are mutually exclusive.
If for whatever reason this function is being called in a synchronous flow, lcb_wait() must be invoked in order for the destruction to take effect
LIBCOUCHBASE_API lcb_STATUS lcb_cmdsubdoc_create_as_deleted | ( | lcb_CMDSUBDOC * | cmd, |
int | flag ) |
If new document created, the server will create it as a tombstone.
Any system or user XATTRs will be stored, but a document body will not be.
LIBCOUCHBASE_API lcb_STATUS lcb_cmdsubdoc_on_behalf_of | ( | lcb_CMDSUBDOC * | cmd, |
const char * | data, | ||
size_t | data_len ) |