Couchbase C Client  3.1.0
Asynchronous C Client for Couchbase
couchbase.h
Go to the documentation of this file.
1 /* -*- Mode: C; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
2 /*
3  * Copyright 2010-2020 Couchbase, Inc.
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 #ifndef LIBCOUCHBASE_COUCHBASE_H
19 #define LIBCOUCHBASE_COUCHBASE_H 1
20 
26 struct lcb_st;
27 
35 typedef struct lcb_st lcb_INSTANCE;
36 typedef struct lcb_HTTP_HANDLE_ lcb_HTTP_HANDLE;
37 
38 #include <stddef.h>
39 #include <time.h>
40 #include <stdarg.h>
41 #include <stdio.h>
42 #include <libcouchbase/sysdefs.h>
43 #include <libcouchbase/assert.h>
44 #include <libcouchbase/visibility.h>
45 #include <libcouchbase/error.h>
46 #include <libcouchbase/iops.h>
47 #include <libcouchbase/configuration.h>
48 #include <libcouchbase/kvbuf.h>
49 #include <libcouchbase/auth.h>
50 #include <libcouchbase/tracing.h>
51 #include <libcouchbase/logger.h>
52 #include <libcouchbase/cntl.h>
53 
54 #ifdef __cplusplus
55 extern "C" {
56 #endif
57 
58 /******************************************************************************
59  ******************************************************************************
60  ******************************************************************************
61  ** INITIALIZATION **
62  ******************************************************************************
63  ******************************************************************************
64  ******************************************************************************/
65 
239 typedef enum {
240  LCB_BTYPE_UNSPEC = 0x00,
241  LCB_BTYPE_COUCHBASE = 0x01,
242  LCB_BTYPE_EPHEMERAL = 0x02,
243  LCB_BTYPE_MEMCACHED = 0x03
244 } lcb_BTYPE;
245 
246 typedef enum {
247  LCB_CONFIG_TRANSPORT_LIST_END = 0,
248  LCB_CONFIG_TRANSPORT_HTTP = 1,
249  LCB_CONFIG_TRANSPORT_CCCP,
250  LCB_CONFIG_TRANSPORT_MAX
251 } lcb_BOOTSTRAP_TRANSPORT;
252 
254 typedef enum {
255  LCB_TYPE_BUCKET = 0x00,
256  LCB_TYPE_CLUSTER = 0x01
257 } lcb_INSTANCE_TYPE;
258 
259 typedef struct lcb_CREATEOPTS_ lcb_CREATEOPTS;
260 
261 LIBCOUCHBASE_API lcb_STATUS lcb_createopts_create(lcb_CREATEOPTS **options, lcb_INSTANCE_TYPE type);
262 LIBCOUCHBASE_API lcb_STATUS lcb_createopts_destroy(lcb_CREATEOPTS *options);
263 LIBCOUCHBASE_API lcb_STATUS lcb_createopts_connstr(lcb_CREATEOPTS *options, const char *connstr, size_t connstr_len);
264 LIBCOUCHBASE_API lcb_STATUS lcb_createopts_bucket(lcb_CREATEOPTS *options, const char *bucket, size_t bucket_len);
265 LIBCOUCHBASE_API lcb_STATUS lcb_createopts_logger(lcb_CREATEOPTS *options, const lcb_LOGGER *logger);
266 LIBCOUCHBASE_API lcb_STATUS lcb_createopts_credentials(lcb_CREATEOPTS *options, const char *username,
267  size_t username_len, const char *password, size_t password_len);
268 LIBCOUCHBASE_API lcb_STATUS lcb_createopts_authenticator(lcb_CREATEOPTS *options, lcb_AUTHENTICATOR *auth);
269 LIBCOUCHBASE_API lcb_STATUS lcb_createopts_io(lcb_CREATEOPTS *options, struct lcb_io_opt_st *io);
270 
314 LIBCOUCHBASE_API
315 lcb_STATUS lcb_create(lcb_INSTANCE **instance, const lcb_CREATEOPTS *options);
316 
339 LIBCOUCHBASE_API
340 lcb_STATUS lcb_connect(lcb_INSTANCE *instance);
341 
351 typedef void (*lcb_bootstrap_callback)(lcb_INSTANCE *instance, lcb_STATUS err);
352 
363 LIBCOUCHBASE_API
364 lcb_bootstrap_callback lcb_set_bootstrap_callback(lcb_INSTANCE *instance, lcb_bootstrap_callback callback);
365 
378 LIBCOUCHBASE_API
379 lcb_STATUS lcb_get_bootstrap_status(lcb_INSTANCE *instance);
380 
389 LIBCOUCHBASE_API
390 void lcb_set_auth(lcb_INSTANCE *instance, lcb_AUTHENTICATOR *auth);
410 typedef struct {
411  uint64_t uuid_;
412  uint64_t seqno_;
413  uint16_t vbid_;
414 } lcb_MUTATION_TOKEN;
415 
416 LIBCOUCHBASE_API int lcb_mutation_token_is_valid(const lcb_MUTATION_TOKEN *token);
417 
427 typedef enum {
429  LCB_RESP_F_FINAL = 0x01,
430 
436  LCB_RESP_F_CLIENTGEN = 0x02,
437 
439  LCB_RESP_F_NMVGEN = 0x04,
440 
443  LCB_RESP_F_EXTDATA = 0x08,
444 
447  LCB_RESP_F_SDSINGLE = 0x10,
448 
450  LCB_RESP_F_ERRINFO = 0x20
451 } lcb_RESPFLAGS;
452 
466 typedef enum {
467  LCB_CALLBACK_DEFAULT = 0,
468  LCB_CALLBACK_GET,
469  LCB_CALLBACK_STORE,
470  LCB_CALLBACK_COUNTER,
471  LCB_CALLBACK_TOUCH,
472  LCB_CALLBACK_REMOVE,
473  LCB_CALLBACK_UNLOCK,
474  LCB_CALLBACK_STATS,
475  LCB_CALLBACK_VERSIONS,
476  LCB_CALLBACK_VERBOSITY,
477  LCB_CALLBACK_OBSERVE,
478  LCB_CALLBACK_GETREPLICA,
479  LCB_CALLBACK_ENDURE,
480  LCB_CALLBACK_HTTP,
481  LCB_CALLBACK_CBFLUSH,
482  LCB_CALLBACK_OBSEQNO,
483  LCB_CALLBACK_STOREDUR,
484  LCB_CALLBACK_SDLOOKUP,
485  LCB_CALLBACK_SDMUTATE,
486  LCB_CALLBACK_NOOP,
487  LCB_CALLBACK_PING,
488  LCB_CALLBACK_DIAG,
489  LCB_CALLBACK_COLLECTIONS_GET_MANIFEST,
490  LCB_CALLBACK_GETCID,
491  LCB_CALLBACK_EXISTS,
492  LCB_CALLBACK__MAX /* Number of callbacks */
493 } lcb_CALLBACK_TYPE;
494 
495 /* The following callback types cannot be set using lcb_install_callback(),
496  * however, their value is passed along as the second argument of their
497  * respective callbacks. This allows you to still use the same callback,
498  * differentiating their meaning by the type. */
499 
501 #define LCB_CALLBACK_VIEWQUERY -1
502 
504 #define LCB_CALLBACK_QUERY -2
505 
507 #define LCB_CALLBACK_IXMGMT -3
508 
510 #define LCB_CALLBACK_ANALYTICS -4
511 
513 #define LCB_CALLBACK_SEARCH -5
514 
515 #define LCB_CALLBACK_OPEN -6
516 
521 typedef enum {
522  LCB_DURABILITYLEVEL_NONE = 0x00,
528  LCB_DURABILITYLEVEL_MAJORITY = 0x01,
532  LCB_DURABILITYLEVEL_MAJORITY_AND_PERSIST_TO_ACTIVE = 0x02,
537  LCB_DURABILITYLEVEL_PERSIST_TO_MAJORITY = 0x03
538 } lcb_DURABILITY_LEVEL;
539 
540 typedef struct lcb_CMDBASE_ lcb_CMDBASE;
541 typedef struct lcb_RESPBASE_ lcb_RESPBASE;
542 
551 typedef void (*lcb_RESPCALLBACK)(lcb_INSTANCE *instance, int cbtype, const lcb_RESPBASE *resp);
552 
574 LIBCOUCHBASE_API
575 lcb_RESPCALLBACK lcb_install_callback(lcb_INSTANCE *instance, int cbtype, lcb_RESPCALLBACK cb);
576 
589 LIBCOUCHBASE_API
590 lcb_RESPCALLBACK lcb_get_callback(lcb_INSTANCE *instance, int cbtype);
591 
598 LIBCOUCHBASE_API
599 const char *lcb_strcbtype(int cbtype);
600 
684 typedef struct lcb_RESPGET_ lcb_RESPGET;
685 
686 LIBCOUCHBASE_API lcb_STATUS lcb_respget_status(const lcb_RESPGET *resp);
687 LIBCOUCHBASE_API lcb_STATUS lcb_respget_error_context(const lcb_RESPGET *resp, const lcb_KEY_VALUE_ERROR_CONTEXT **ctx);
688 LIBCOUCHBASE_API lcb_STATUS lcb_respget_cookie(const lcb_RESPGET *resp, void **cookie);
689 LIBCOUCHBASE_API lcb_STATUS lcb_respget_cas(const lcb_RESPGET *resp, uint64_t *cas);
690 LIBCOUCHBASE_API lcb_STATUS lcb_respget_datatype(const lcb_RESPGET *resp, uint8_t *datatype);
691 LIBCOUCHBASE_API lcb_STATUS lcb_respget_flags(const lcb_RESPGET *resp, uint32_t *flags);
692 LIBCOUCHBASE_API lcb_STATUS lcb_respget_key(const lcb_RESPGET *resp, const char **key, size_t *key_len);
693 LIBCOUCHBASE_API lcb_STATUS lcb_respget_value(const lcb_RESPGET *resp, const char **value, size_t *value_len);
694 
695 typedef struct lcb_CMDGET_ lcb_CMDGET;
696 
697 LIBCOUCHBASE_API lcb_STATUS lcb_cmdget_create(lcb_CMDGET **cmd);
698 LIBCOUCHBASE_API lcb_STATUS lcb_cmdget_destroy(lcb_CMDGET *cmd);
699 LIBCOUCHBASE_API lcb_STATUS lcb_cmdget_parent_span(lcb_CMDGET *cmd, lcbtrace_SPAN *span);
700 LIBCOUCHBASE_API lcb_STATUS lcb_cmdget_collection(lcb_CMDGET *cmd, const char *scope, size_t scope_len,
701  const char *collection, size_t collection_len);
702 LIBCOUCHBASE_API lcb_STATUS lcb_cmdget_key(lcb_CMDGET *cmd, const char *key, size_t key_len);
703 LIBCOUCHBASE_API lcb_STATUS lcb_cmdget_expiry(lcb_CMDGET *cmd, uint32_t expiration);
704 LIBCOUCHBASE_API lcb_STATUS lcb_cmdget_locktime(lcb_CMDGET *cmd, uint32_t duration);
705 LIBCOUCHBASE_API lcb_STATUS lcb_cmdget_timeout(lcb_CMDGET *cmd, uint32_t timeout);
706 
707 LIBCOUCHBASE_API lcb_STATUS lcb_get(lcb_INSTANCE *instance, void *cookie, const lcb_CMDGET *cmd);
775 typedef enum {
776  LCB_REPLICA_MODE_ANY = 0x00,
777  LCB_REPLICA_MODE_ALL = 0x01,
778  LCB_REPLICA_MODE_IDX0 = 0x02,
779  LCB_REPLICA_MODE_IDX1 = 0x03,
780  LCB_REPLICA_MODE_IDX2 = 0x04,
781  LCB_REPLICA_MODE__MAX
782 } lcb_REPLICA_MODE;
783 
784 typedef struct lcb_RESPGETREPLICA_ lcb_RESPGETREPLICA;
785 
786 LIBCOUCHBASE_API lcb_STATUS lcb_respgetreplica_status(const lcb_RESPGETREPLICA *resp);
787 LIBCOUCHBASE_API lcb_STATUS lcb_respgetreplica_error_context(const lcb_RESPGETREPLICA *resp,
788  const lcb_KEY_VALUE_ERROR_CONTEXT **ctx);
789 LIBCOUCHBASE_API lcb_STATUS lcb_respgetreplica_cookie(const lcb_RESPGETREPLICA *resp, void **cookie);
790 LIBCOUCHBASE_API lcb_STATUS lcb_respgetreplica_cas(const lcb_RESPGETREPLICA *resp, uint64_t *cas);
791 LIBCOUCHBASE_API lcb_STATUS lcb_respgetreplica_datatype(const lcb_RESPGETREPLICA *resp, uint8_t *datatype);
792 LIBCOUCHBASE_API lcb_STATUS lcb_respgetreplica_flags(const lcb_RESPGETREPLICA *resp, uint32_t *flags);
793 LIBCOUCHBASE_API lcb_STATUS lcb_respgetreplica_key(const lcb_RESPGETREPLICA *resp, const char **key, size_t *key_len);
794 LIBCOUCHBASE_API lcb_STATUS lcb_respgetreplica_value(const lcb_RESPGETREPLICA *resp, const char **value,
795  size_t *value_len);
796 LIBCOUCHBASE_API int lcb_respgetreplica_is_final(const lcb_RESPGETREPLICA *resp);
797 
798 typedef struct lcb_CMDGETREPLICA_ lcb_CMDGETREPLICA;
799 
800 LIBCOUCHBASE_API lcb_STATUS lcb_cmdgetreplica_create(lcb_CMDGETREPLICA **cmd, lcb_REPLICA_MODE mode);
801 LIBCOUCHBASE_API lcb_STATUS lcb_cmdgetreplica_destroy(lcb_CMDGETREPLICA *cmd);
802 LIBCOUCHBASE_API lcb_STATUS lcb_cmdgetreplica_parent_span(lcb_CMDGETREPLICA *cmd, lcbtrace_SPAN *span);
803 LIBCOUCHBASE_API lcb_STATUS lcb_cmdgetreplica_collection(lcb_CMDGETREPLICA *cmd, const char *scope, size_t scope_len,
804  const char *collection, size_t collection_len);
805 LIBCOUCHBASE_API lcb_STATUS lcb_cmdgetreplica_key(lcb_CMDGETREPLICA *cmd, const char *key, size_t key_len);
806 LIBCOUCHBASE_API lcb_STATUS lcb_cmdgetreplica_timeout(lcb_CMDGETREPLICA *cmd, uint32_t timeout);
807 LIBCOUCHBASE_API lcb_STATUS lcb_getreplica(lcb_INSTANCE *instance, void *cookie, const lcb_CMDGETREPLICA *cmd);
808 
811 typedef struct lcb_RESPEXISTS_ lcb_RESPEXISTS;
812 
813 LIBCOUCHBASE_API lcb_STATUS lcb_respexists_status(const lcb_RESPEXISTS *resp);
814 LIBCOUCHBASE_API int lcb_respexists_is_found(const lcb_RESPEXISTS *resp);
815 LIBCOUCHBASE_API lcb_STATUS lcb_respexists_error_context(const lcb_RESPEXISTS *resp,
816  const lcb_KEY_VALUE_ERROR_CONTEXT **ctx);
817 LIBCOUCHBASE_API lcb_STATUS lcb_respexists_cookie(const lcb_RESPEXISTS *resp, void **cookie);
818 LIBCOUCHBASE_API lcb_STATUS lcb_respexists_cas(const lcb_RESPEXISTS *resp, uint64_t *cas);
819 LIBCOUCHBASE_API lcb_STATUS lcb_respexists_key(const lcb_RESPEXISTS *resp, const char **key, size_t *key_len);
820 
821 typedef struct lcb_CMDEXISTS_ lcb_CMDEXISTS;
822 
823 LIBCOUCHBASE_API lcb_STATUS lcb_cmdexists_create(lcb_CMDEXISTS **cmd);
824 LIBCOUCHBASE_API lcb_STATUS lcb_cmdexists_destroy(lcb_CMDEXISTS *cmd);
825 LIBCOUCHBASE_API lcb_STATUS lcb_cmdexists_parent_span(lcb_CMDEXISTS *cmd, lcbtrace_SPAN *span);
826 LIBCOUCHBASE_API lcb_STATUS lcb_cmdexists_collection(lcb_CMDEXISTS *cmd, const char *scope, size_t scope_len,
827  const char *collection, size_t collection_len);
828 LIBCOUCHBASE_API lcb_STATUS lcb_cmdexists_key(lcb_CMDEXISTS *cmd, const char *key, size_t key_len);
829 LIBCOUCHBASE_API lcb_STATUS lcb_cmdexists_timeout(lcb_CMDEXISTS *cmd, uint32_t timeout);
830 
831 LIBCOUCHBASE_API lcb_STATUS lcb_exists(lcb_INSTANCE *instance, void *cookie, const lcb_CMDEXISTS *cmd);
832 
847 typedef enum {
856  LCB_STORE_UPSERT = 0x00,
857 
862  LCB_STORE_INSERT = 0x01,
863 
868  LCB_STORE_REPLACE = 0x02,
869 
875  LCB_STORE_APPEND = 0x04,
876 
880  LCB_STORE_PREPEND = 0x05
881 } lcb_STORE_OPERATION;
882 
940 typedef struct lcb_RESPSTORE_ lcb_RESPSTORE;
941 
942 LIBCOUCHBASE_API lcb_STATUS lcb_respstore_status(const lcb_RESPSTORE *resp);
943 LIBCOUCHBASE_API lcb_STATUS lcb_respstore_error_context(const lcb_RESPSTORE *resp,
944  const lcb_KEY_VALUE_ERROR_CONTEXT **ctx);
945 LIBCOUCHBASE_API lcb_STATUS lcb_respstore_cookie(const lcb_RESPSTORE *resp, void **cookie);
946 LIBCOUCHBASE_API lcb_STATUS lcb_respstore_cas(const lcb_RESPSTORE *resp, uint64_t *cas);
947 LIBCOUCHBASE_API lcb_STATUS lcb_respstore_key(const lcb_RESPSTORE *resp, const char **key, size_t *key_len);
948 LIBCOUCHBASE_API lcb_STATUS lcb_respstore_operation(const lcb_RESPSTORE *resp, lcb_STORE_OPERATION *operation);
949 LIBCOUCHBASE_API lcb_STATUS lcb_respstore_mutation_token(const lcb_RESPSTORE *resp, lcb_MUTATION_TOKEN *token);
950 
951 LIBCOUCHBASE_API int lcb_respstore_observe_attached(const lcb_RESPSTORE *resp);
952 LIBCOUCHBASE_API lcb_STATUS lcb_respstore_observe_stored(const lcb_RESPSTORE *resp, int *store_ok);
953 LIBCOUCHBASE_API lcb_STATUS lcb_respstore_observe_master_exists(const lcb_RESPSTORE *resp, int *master_exists);
954 LIBCOUCHBASE_API lcb_STATUS lcb_respstore_observe_master_persisted(const lcb_RESPSTORE *resp, int *master_persisted);
955 LIBCOUCHBASE_API lcb_STATUS lcb_respstore_observe_num_responses(const lcb_RESPSTORE *resp, uint16_t *num_responses);
956 LIBCOUCHBASE_API lcb_STATUS lcb_respstore_observe_num_persisted(const lcb_RESPSTORE *resp, uint16_t *num_persisted);
957 LIBCOUCHBASE_API lcb_STATUS lcb_respstore_observe_num_replicated(const lcb_RESPSTORE *resp, uint16_t *num_replicated);
958 
959 typedef struct lcb_CMDSTORE_ lcb_CMDSTORE;
960 
961 LIBCOUCHBASE_API lcb_STATUS lcb_cmdstore_create(lcb_CMDSTORE **cmd, lcb_STORE_OPERATION operation);
962 LIBCOUCHBASE_API lcb_STATUS lcb_cmdstore_destroy(lcb_CMDSTORE *cmd);
963 LIBCOUCHBASE_API lcb_STATUS lcb_cmdstore_parent_span(lcb_CMDSTORE *cmd, lcbtrace_SPAN *span);
964 LIBCOUCHBASE_API lcb_STATUS lcb_cmdstore_collection(lcb_CMDSTORE *cmd, const char *scope, size_t scope_len,
965  const char *collection, size_t collection_len);
966 LIBCOUCHBASE_API lcb_STATUS lcb_cmdstore_key(lcb_CMDSTORE *cmd, const char *key, size_t key_len);
967 LIBCOUCHBASE_API lcb_STATUS lcb_cmdstore_value(lcb_CMDSTORE *cmd, const char *value, size_t value_len);
968 LIBCOUCHBASE_API lcb_STATUS lcb_cmdstore_value_iov(lcb_CMDSTORE *cmd, const lcb_IOV *value, size_t value_len);
969 LIBCOUCHBASE_API lcb_STATUS lcb_cmdstore_expiry(lcb_CMDSTORE *cmd, uint32_t expiration);
970 LIBCOUCHBASE_API lcb_STATUS lcb_cmdstore_cas(lcb_CMDSTORE *cmd, uint64_t cas);
971 LIBCOUCHBASE_API lcb_STATUS lcb_cmdstore_flags(lcb_CMDSTORE *cmd, uint32_t flags);
972 LIBCOUCHBASE_API lcb_STATUS lcb_cmdstore_datatype(lcb_CMDSTORE *cmd, uint8_t datatype);
973 LIBCOUCHBASE_API lcb_STATUS lcb_cmdstore_durability(lcb_CMDSTORE *cmd, lcb_DURABILITY_LEVEL level);
974 LIBCOUCHBASE_API lcb_STATUS lcb_cmdstore_durability_observe(lcb_CMDSTORE *cmd, int persist_to, int replicate_to);
975 LIBCOUCHBASE_API lcb_STATUS lcb_cmdstore_timeout(lcb_CMDSTORE *cmd, uint32_t timeout);
976 LIBCOUCHBASE_API lcb_STATUS lcb_store(lcb_INSTANCE *instance, void *cookie, const lcb_CMDSTORE *cmd);
987 typedef void (*lcb_open_callback)(lcb_INSTANCE *instance, lcb_STATUS err);
994 LIBCOUCHBASE_API lcb_open_callback lcb_set_open_callback(lcb_INSTANCE *instance, lcb_open_callback callback);
995 
1005 LIBCOUCHBASE_API lcb_STATUS lcb_open(lcb_INSTANCE *instance, const char *bucket, size_t bucket_len);
1060 typedef struct lcb_RESPREMOVE_ lcb_RESPREMOVE;
1061 
1062 LIBCOUCHBASE_API lcb_STATUS lcb_respremove_status(const lcb_RESPREMOVE *resp);
1063 LIBCOUCHBASE_API lcb_STATUS lcb_respremove_error_context(const lcb_RESPREMOVE *resp,
1064  const lcb_KEY_VALUE_ERROR_CONTEXT **ctx);
1065 LIBCOUCHBASE_API lcb_STATUS lcb_respremove_cookie(const lcb_RESPREMOVE *resp, void **cookie);
1066 LIBCOUCHBASE_API lcb_STATUS lcb_respremove_cas(const lcb_RESPREMOVE *resp, uint64_t *cas);
1067 LIBCOUCHBASE_API lcb_STATUS lcb_respremove_key(const lcb_RESPREMOVE *resp, const char **key, size_t *key_len);
1068 LIBCOUCHBASE_API lcb_STATUS lcb_respremove_mutation_token(const lcb_RESPREMOVE *resp, lcb_MUTATION_TOKEN *token);
1069 
1070 typedef struct lcb_CMDREMOVE_ lcb_CMDREMOVE;
1071 
1072 LIBCOUCHBASE_API lcb_STATUS lcb_cmdremove_create(lcb_CMDREMOVE **cmd);
1073 LIBCOUCHBASE_API lcb_STATUS lcb_cmdremove_destroy(lcb_CMDREMOVE *cmd);
1074 LIBCOUCHBASE_API lcb_STATUS lcb_cmdremove_parent_span(lcb_CMDREMOVE *cmd, lcbtrace_SPAN *span);
1075 LIBCOUCHBASE_API lcb_STATUS lcb_cmdremove_collection(lcb_CMDREMOVE *cmd, const char *scope, size_t scope_len,
1076  const char *collection, size_t collection_len);
1077 LIBCOUCHBASE_API lcb_STATUS lcb_cmdremove_key(lcb_CMDREMOVE *cmd, const char *key, size_t key_len);
1078 LIBCOUCHBASE_API lcb_STATUS lcb_cmdremove_cas(lcb_CMDREMOVE *cmd, uint64_t cas);
1079 LIBCOUCHBASE_API lcb_STATUS lcb_cmdremove_durability(lcb_CMDREMOVE *cmd, lcb_DURABILITY_LEVEL level);
1080 LIBCOUCHBASE_API lcb_STATUS lcb_cmdremove_timeout(lcb_CMDREMOVE *cmd, uint32_t timeout);
1081 LIBCOUCHBASE_API lcb_STATUS lcb_remove(lcb_INSTANCE *instance, void *cookie, const lcb_CMDREMOVE *cmd);
1082 
1144 typedef struct lcb_RESPCOUNTER_ lcb_RESPCOUNTER;
1145 
1146 LIBCOUCHBASE_API lcb_STATUS lcb_respcounter_status(const lcb_RESPCOUNTER *resp);
1147 LIBCOUCHBASE_API lcb_STATUS lcb_respcounter_error_context(const lcb_RESPCOUNTER *resp,
1148  const lcb_KEY_VALUE_ERROR_CONTEXT **ctx);
1149 LIBCOUCHBASE_API lcb_STATUS lcb_respcounter_cookie(const lcb_RESPCOUNTER *resp, void **cookie);
1150 LIBCOUCHBASE_API lcb_STATUS lcb_respcounter_cas(const lcb_RESPCOUNTER *resp, uint64_t *cas);
1151 LIBCOUCHBASE_API lcb_STATUS lcb_respcounter_key(const lcb_RESPCOUNTER *resp, const char **key, size_t *key_len);
1152 LIBCOUCHBASE_API lcb_STATUS lcb_respcounter_mutation_token(const lcb_RESPCOUNTER *resp, lcb_MUTATION_TOKEN *token);
1153 LIBCOUCHBASE_API lcb_STATUS lcb_respcounter_value(const lcb_RESPCOUNTER *resp, uint64_t *value);
1154 
1155 typedef struct lcb_CMDCOUNTER_ lcb_CMDCOUNTER;
1156 
1157 LIBCOUCHBASE_API lcb_STATUS lcb_cmdcounter_create(lcb_CMDCOUNTER **cmd);
1158 LIBCOUCHBASE_API lcb_STATUS lcb_cmdcounter_destroy(lcb_CMDCOUNTER *cmd);
1159 LIBCOUCHBASE_API lcb_STATUS lcb_cmdcounter_parent_span(lcb_CMDCOUNTER *cmd, lcbtrace_SPAN *span);
1160 LIBCOUCHBASE_API lcb_STATUS lcb_cmdcounter_collection(lcb_CMDCOUNTER *cmd, const char *scope, size_t scope_len,
1161  const char *collection, size_t collection_len);
1162 LIBCOUCHBASE_API lcb_STATUS lcb_cmdcounter_key(lcb_CMDCOUNTER *cmd, const char *key, size_t key_len);
1163 LIBCOUCHBASE_API lcb_STATUS lcb_cmdcounter_expiry(lcb_CMDCOUNTER *cmd, uint32_t expiration);
1164 LIBCOUCHBASE_API lcb_STATUS lcb_cmdcounter_delta(lcb_CMDCOUNTER *cmd, int64_t number);
1165 LIBCOUCHBASE_API lcb_STATUS lcb_cmdcounter_initial(lcb_CMDCOUNTER *cmd, uint64_t number);
1166 LIBCOUCHBASE_API lcb_STATUS lcb_cmdcounter_durability(lcb_CMDCOUNTER *cmd, lcb_DURABILITY_LEVEL level);
1167 LIBCOUCHBASE_API lcb_STATUS lcb_cmdcounter_cas(lcb_CMDCOUNTER *cmd, uint64_t cas);
1168 LIBCOUCHBASE_API lcb_STATUS lcb_cmdcounter_timeout(lcb_CMDCOUNTER *cmd, uint32_t timeout);
1169 LIBCOUCHBASE_API lcb_STATUS lcb_counter(lcb_INSTANCE *instance, void *cookie, const lcb_CMDCOUNTER *cmd);
1170 
1173 /* @ingroup lcb-kv-api
1174  * @defgroup lcb-lock Lock/Unlock
1175  * @details Documents may be locked and unlocked on the server. While a document
1176  * is locked, any attempt to modify it (or lock it again) will fail.
1177  *
1178  * @note Locks are not persistent across nodes (if a node fails over, the lock
1179  * is not transferred to a replica).
1180  * @note The recommended way to manage access and concurrency control for
1181  * documents in Couchbase is through the CAS, which can also be considered
1182  * a form of opportunistic locking.
1183  *
1184  * @par Locking an item
1185  * There is no exclusive function to lock an item. Locking an item is done
1186  * using @ref lcb_get(), by setting the lcb_cmdget_locktime.
1187  *
1188  * @addtogroup lcb-lock
1189  * @{
1190  */
1191 
1227 typedef struct lcb_RESPUNLOCK_ lcb_RESPUNLOCK;
1228 
1229 LIBCOUCHBASE_API lcb_STATUS lcb_respunlock_status(const lcb_RESPUNLOCK *resp);
1230 LIBCOUCHBASE_API lcb_STATUS lcb_respunlock_error_context(const lcb_RESPUNLOCK *resp,
1231  const lcb_KEY_VALUE_ERROR_CONTEXT **ctx);
1232 LIBCOUCHBASE_API lcb_STATUS lcb_respunlock_cookie(const lcb_RESPUNLOCK *resp, void **cookie);
1233 LIBCOUCHBASE_API lcb_STATUS lcb_respunlock_cas(const lcb_RESPUNLOCK *resp, uint64_t *cas);
1234 LIBCOUCHBASE_API lcb_STATUS lcb_respunlock_key(const lcb_RESPUNLOCK *resp, const char **key, size_t *key_len);
1235 
1236 typedef struct lcb_CMDUNLOCK_ lcb_CMDUNLOCK;
1237 
1238 LIBCOUCHBASE_API lcb_STATUS lcb_cmdunlock_create(lcb_CMDUNLOCK **cmd);
1239 LIBCOUCHBASE_API lcb_STATUS lcb_cmdunlock_destroy(lcb_CMDUNLOCK *cmd);
1240 LIBCOUCHBASE_API lcb_STATUS lcb_cmdunlock_parent_span(lcb_CMDUNLOCK *cmd, lcbtrace_SPAN *span);
1241 LIBCOUCHBASE_API lcb_STATUS lcb_cmdunlock_collection(lcb_CMDUNLOCK *cmd, const char *scope, size_t scope_len,
1242  const char *collection, size_t collection_len);
1243 LIBCOUCHBASE_API lcb_STATUS lcb_cmdunlock_key(lcb_CMDUNLOCK *cmd, const char *key, size_t key_len);
1244 LIBCOUCHBASE_API lcb_STATUS lcb_cmdunlock_cas(lcb_CMDUNLOCK *cmd, uint64_t cas);
1245 LIBCOUCHBASE_API lcb_STATUS lcb_cmdunlock_timeout(lcb_CMDUNLOCK *cmd, uint32_t timeout);
1246 LIBCOUCHBASE_API lcb_STATUS lcb_unlock(lcb_INSTANCE *instance, void *cookie, const lcb_CMDUNLOCK *cmd);
1247 
1250 /* @ingroup lcb-kv-api
1251  * @defgroup lcb-touch Touch/Expiry
1252  * @brief Modify or clear a document's expiration time
1253  * @details Couchbase allows documents to contain expiration times
1254  * (see lcb_CMDBASE::exptime). Most operations allow the expiry time to be
1255  * updated, however lcb_touch3() allows the exclusive update of the expiration
1256  * time without additional network overhead.
1257  *
1258  * @addtogroup lcb-touch
1259  * @{
1260  */
1261 
1292 typedef struct lcb_RESPTOUCH_ lcb_RESPTOUCH;
1293 
1294 LIBCOUCHBASE_API lcb_STATUS lcb_resptouch_status(const lcb_RESPTOUCH *resp);
1295 LIBCOUCHBASE_API lcb_STATUS lcb_resptouch_error_context(const lcb_RESPTOUCH *resp,
1296  const lcb_KEY_VALUE_ERROR_CONTEXT **ctx);
1297 LIBCOUCHBASE_API lcb_STATUS lcb_resptouch_cookie(const lcb_RESPTOUCH *resp, void **cookie);
1298 LIBCOUCHBASE_API lcb_STATUS lcb_resptouch_cas(const lcb_RESPTOUCH *resp, uint64_t *cas);
1299 LIBCOUCHBASE_API lcb_STATUS lcb_resptouch_key(const lcb_RESPTOUCH *resp, const char **key, size_t *key_len);
1300 LIBCOUCHBASE_API lcb_STATUS lcb_resptouch_mutation_token(const lcb_RESPTOUCH *resp, lcb_MUTATION_TOKEN *token);
1301 
1302 typedef struct lcb_CMDTOUCH_ lcb_CMDTOUCH;
1303 
1304 LIBCOUCHBASE_API lcb_STATUS lcb_cmdtouch_create(lcb_CMDTOUCH **cmd);
1305 LIBCOUCHBASE_API lcb_STATUS lcb_cmdtouch_destroy(lcb_CMDTOUCH *cmd);
1306 LIBCOUCHBASE_API lcb_STATUS lcb_cmdtouch_parent_span(lcb_CMDTOUCH *cmd, lcbtrace_SPAN *span);
1307 LIBCOUCHBASE_API lcb_STATUS lcb_cmdtouch_collection(lcb_CMDTOUCH *cmd, const char *scope, size_t scope_len,
1308  const char *collection, size_t collection_len);
1309 LIBCOUCHBASE_API lcb_STATUS lcb_cmdtouch_key(lcb_CMDTOUCH *cmd, const char *key, size_t key_len);
1310 LIBCOUCHBASE_API lcb_STATUS lcb_cmdtouch_expiry(lcb_CMDTOUCH *cmd, uint32_t expiration);
1311 LIBCOUCHBASE_API lcb_STATUS lcb_cmdtouch_durability(lcb_CMDTOUCH *cmd, lcb_DURABILITY_LEVEL level);
1312 LIBCOUCHBASE_API lcb_STATUS lcb_cmdtouch_timeout(lcb_CMDTOUCH *cmd, uint32_t timeout);
1313 LIBCOUCHBASE_API lcb_STATUS lcb_touch(lcb_INSTANCE *instance, void *cookie, const lcb_CMDTOUCH *cmd);
1314 
1332 typedef enum {
1333  LCB_PING_STATUS_OK = 0,
1334  LCB_PING_STATUS_TIMEOUT,
1335  LCB_PING_STATUS_ERROR,
1336  LCB_PING_STATUS_INVALID, /* bad index or argument */
1337  LCB_PING_STATUS__MAX
1338 } lcb_PING_STATUS;
1339 
1345 typedef enum {
1346  LCB_PING_SERVICE_KV = 0,
1347  LCB_PING_SERVICE_VIEWS,
1348  LCB_PING_SERVICE_QUERY,
1349  LCB_PING_SERVICE_SEARCH,
1350  LCB_PING_SERVICE_ANALYTICS,
1351  LCB_PING_SERVICE__MAX
1352 } lcb_PING_SERVICE;
1353 
1354 typedef struct lcb_RESPPING_ lcb_RESPPING;
1355 
1356 LIBCOUCHBASE_API lcb_STATUS lcb_respping_status(const lcb_RESPPING *resp);
1357 LIBCOUCHBASE_API lcb_STATUS lcb_respping_cookie(const lcb_RESPPING *resp, void **cookie);
1358 LIBCOUCHBASE_API lcb_STATUS lcb_respping_value(const lcb_RESPPING *resp, const char **json, size_t *json_len);
1359 LIBCOUCHBASE_API lcb_STATUS lcb_respping_report_id(const lcb_RESPPING *resp, const char **report_id,
1360  size_t *report_id_len);
1361 LIBCOUCHBASE_API size_t lcb_respping_result_size(const lcb_RESPPING *resp);
1362 LIBCOUCHBASE_API lcb_PING_STATUS lcb_respping_result_status(const lcb_RESPPING *resp, size_t index);
1363 LIBCOUCHBASE_API lcb_STATUS lcb_respping_result_id(const lcb_RESPPING *resp, size_t index, const char **endpoint_id,
1364  size_t *endpoint_id_len);
1365 LIBCOUCHBASE_API lcb_STATUS lcb_respping_result_service(const lcb_RESPPING *resp, size_t index, lcb_PING_SERVICE *type);
1366 LIBCOUCHBASE_API lcb_STATUS lcb_respping_result_remote(const lcb_RESPPING *resp, size_t index, const char **address,
1367  size_t *address_len);
1368 LIBCOUCHBASE_API lcb_STATUS lcb_respping_result_local(const lcb_RESPPING *resp, size_t index, const char **address,
1369  size_t *address_len);
1370 LIBCOUCHBASE_API lcb_STATUS lcb_respping_result_latency(const lcb_RESPPING *resp, size_t index, uint64_t *latency);
1371 
1372 LIBCOUCHBASE_API lcb_STATUS lcb_respping_result_namespace(const lcb_RESPPING *resp, size_t index, const char **name,
1373  size_t *name_len);
1374 
1375 LCB_DEPRECATED2(LIBCOUCHBASE_API lcb_STATUS lcb_respping_result_scope(const lcb_RESPPING *resp, size_t index,
1376  const char **name, size_t *name_len),
1377  "Use lcb_respping_result_namespace");
1378 
1379 typedef struct lcb_CMDPING_ lcb_CMDPING;
1380 
1381 LIBCOUCHBASE_API lcb_STATUS lcb_cmdping_create(lcb_CMDPING **cmd);
1382 LIBCOUCHBASE_API lcb_STATUS lcb_cmdping_destroy(lcb_CMDPING *cmd);
1383 LIBCOUCHBASE_API lcb_STATUS lcb_cmdping_parent_span(lcb_CMDPING *cmd, lcbtrace_SPAN *span);
1384 LIBCOUCHBASE_API lcb_STATUS lcb_cmdping_report_id(lcb_CMDPING *cmd, const char *report_id, size_t report_id_len);
1385 LIBCOUCHBASE_API lcb_STATUS lcb_cmdping_all(lcb_CMDPING *cmd);
1386 LIBCOUCHBASE_API lcb_STATUS lcb_cmdping_kv(lcb_CMDPING *cmd, int enable);
1387 LIBCOUCHBASE_API lcb_STATUS lcb_cmdping_query(lcb_CMDPING *cmd, int enable);
1388 LIBCOUCHBASE_API lcb_STATUS lcb_cmdping_views(lcb_CMDPING *cmd, int enable);
1389 LIBCOUCHBASE_API lcb_STATUS lcb_cmdping_search(lcb_CMDPING *cmd, int enable);
1390 LIBCOUCHBASE_API lcb_STATUS lcb_cmdping_analytics(lcb_CMDPING *cmd, int enable);
1391 LIBCOUCHBASE_API lcb_STATUS lcb_cmdping_no_metrics(lcb_CMDPING *cmd, int enable);
1392 LIBCOUCHBASE_API lcb_STATUS lcb_cmdping_encode_json(lcb_CMDPING *cmd, int enable, int pretty, int with_details);
1393 LIBCOUCHBASE_API lcb_STATUS lcb_cmdping_timeout(lcb_CMDPING *cmd, uint32_t timeout);
1394 LIBCOUCHBASE_API lcb_STATUS lcb_ping(lcb_INSTANCE *instance, void *cookie, const lcb_CMDPING *cmd);
1395 
1396 typedef struct lcb_RESPDIAG_ lcb_RESPDIAG;
1397 
1398 LIBCOUCHBASE_API lcb_STATUS lcb_respdiag_status(const lcb_RESPDIAG *resp);
1399 LIBCOUCHBASE_API lcb_STATUS lcb_respdiag_cookie(const lcb_RESPDIAG *resp, void **cookie);
1400 LIBCOUCHBASE_API lcb_STATUS lcb_respdiag_value(const lcb_RESPDIAG *resp, const char **json, size_t *json_len);
1401 
1402 typedef struct lcb_CMDDIAG_ lcb_CMDDIAG;
1403 
1404 LIBCOUCHBASE_API lcb_STATUS lcb_cmddiag_create(lcb_CMDDIAG **cmd);
1405 LIBCOUCHBASE_API lcb_STATUS lcb_cmddiag_destroy(lcb_CMDDIAG *cmd);
1406 LIBCOUCHBASE_API lcb_STATUS lcb_cmddiag_report_id(lcb_CMDDIAG *cmd, const char *report_id, size_t report_id_len);
1407 LIBCOUCHBASE_API lcb_STATUS lcb_cmddiag_prettify(lcb_CMDDIAG *cmd, int enable);
1445 LIBCOUCHBASE_API lcb_STATUS lcb_diag(lcb_INSTANCE *instance, void *cookie, const lcb_CMDDIAG *cmd);
1446 
1449 /* @ingroup lcb-public-api
1450  * @defgroup lcb-http HTTP Client
1451  * @brief Access Couchbase HTTP APIs
1452  * @details The low-level HTTP client may be used to access various HTTP-based
1453  * Couchbase APIs.
1454  *
1455  * Note that existing higher level APIs can be used for N1QL queries (see
1456  * @ref lcb-n1ql-api) and MapReduce view queries (see @ref lcb-view-api)
1457  *
1458  * @addtogroup lcb-http
1459  * @{
1460  */
1461 
1465 typedef enum {
1470  LCB_HTTP_TYPE_VIEW = 0,
1471 
1478  LCB_HTTP_TYPE_MANAGEMENT = 1,
1479 
1483  LCB_HTTP_TYPE_RAW = 2,
1484 
1486  LCB_HTTP_TYPE_QUERY = 3,
1487 
1489  LCB_HTTP_TYPE_SEARCH = 4,
1490 
1492  LCB_HTTP_TYPE_ANALYTICS = 5,
1493 
1499  LCB_HTTP_TYPE_PING = 6,
1500 
1501  LCB_HTTP_TYPE_EVENTING = 7,
1502 
1503  LCB_HTTP_TYPE_MAX
1504 } lcb_HTTP_TYPE;
1505 
1512 typedef enum {
1513  LCB_HTTP_METHOD_GET = 0,
1514  LCB_HTTP_METHOD_POST = 1,
1515  LCB_HTTP_METHOD_PUT = 2,
1516  LCB_HTTP_METHOD_DELETE = 3,
1517  LCB_HTTP_METHOD_MAX = 4
1518 } lcb_HTTP_METHOD;
1519 
1589 typedef struct lcb_RESPHTTP_ lcb_RESPHTTP;
1590 
1591 LIBCOUCHBASE_API lcb_STATUS lcb_resphttp_status(const lcb_RESPHTTP *resp);
1592 LIBCOUCHBASE_API lcb_STATUS lcb_resphttp_cookie(const lcb_RESPHTTP *resp, void **cookie);
1593 LIBCOUCHBASE_API lcb_STATUS lcb_resphttp_http_status(const lcb_RESPHTTP *resp, uint16_t *status);
1594 LIBCOUCHBASE_API lcb_STATUS lcb_resphttp_path(const lcb_RESPHTTP *resp, const char **path, size_t *path_len);
1595 LIBCOUCHBASE_API lcb_STATUS lcb_resphttp_body(const lcb_RESPHTTP *resp, const char **body, size_t *body_len);
1596 LIBCOUCHBASE_API lcb_STATUS lcb_resphttp_handle(const lcb_RESPHTTP *resp, lcb_HTTP_HANDLE **handle);
1597 LIBCOUCHBASE_API lcb_STATUS lcb_resphttp_error_context(const lcb_RESPHTTP *resp, const lcb_HTTP_ERROR_CONTEXT **ctx);
1598 
1599 LIBCOUCHBASE_API int lcb_resphttp_is_final(const lcb_RESPHTTP *resp);
1604 LIBCOUCHBASE_API lcb_STATUS lcb_resphttp_headers(const lcb_RESPHTTP *resp, const char *const **headers);
1605 
1606 typedef struct lcb_CMDHTTP_ lcb_CMDHTTP;
1607 
1608 LIBCOUCHBASE_API lcb_STATUS lcb_cmdhttp_create(lcb_CMDHTTP **cmd, lcb_HTTP_TYPE type);
1609 LIBCOUCHBASE_API lcb_STATUS lcb_cmdhttp_destroy(lcb_CMDHTTP *cmd);
1610 LIBCOUCHBASE_API lcb_STATUS lcb_cmdhttp_parent_span(lcb_CMDHTTP *cmd, lcbtrace_SPAN *span);
1611 LIBCOUCHBASE_API lcb_STATUS lcb_cmdhttp_method(lcb_CMDHTTP *cmd, lcb_HTTP_METHOD method);
1612 LIBCOUCHBASE_API lcb_STATUS lcb_cmdhttp_path(lcb_CMDHTTP *cmd, const char *path, size_t path_len);
1613 LIBCOUCHBASE_API lcb_STATUS lcb_cmdhttp_content_type(lcb_CMDHTTP *cmd, const char *content_type,
1614  size_t content_type_len);
1615 LIBCOUCHBASE_API lcb_STATUS lcb_cmdhttp_body(lcb_CMDHTTP *cmd, const char *body, size_t body_len);
1616 LIBCOUCHBASE_API lcb_STATUS lcb_cmdhttp_handle(lcb_CMDHTTP *cmd, lcb_HTTP_HANDLE **handle);
1617 LIBCOUCHBASE_API lcb_STATUS lcb_cmdhttp_username(lcb_CMDHTTP *cmd, const char *username, size_t username_len);
1618 LIBCOUCHBASE_API lcb_STATUS lcb_cmdhttp_password(lcb_CMDHTTP *cmd, const char *password, size_t password_len);
1619 LIBCOUCHBASE_API lcb_STATUS lcb_cmdhttp_host(lcb_CMDHTTP *cmd, const char *host, size_t host_len);
1620 LIBCOUCHBASE_API lcb_STATUS lcb_cmdhttp_streaming(lcb_CMDHTTP *cmd, int streaming);
1621 LIBCOUCHBASE_API lcb_STATUS lcb_cmdhttp_skip_auth_header(lcb_CMDHTTP *cmd, int skip_auth);
1622 LIBCOUCHBASE_API lcb_STATUS lcb_cmdhttp_timeout(lcb_CMDHTTP *cmd, uint32_t timeout);
1623 LIBCOUCHBASE_API lcb_STATUS lcb_http(lcb_INSTANCE *instance, void *cookie, const lcb_CMDHTTP *cmd);
1624 
1650 LIBCOUCHBASE_API lcb_STATUS lcb_http_cancel(lcb_INSTANCE *instance, lcb_HTTP_HANDLE *handle);
1651 
1717 LIBCOUCHBASE_API
1718 void lcb_set_cookie(lcb_INSTANCE *instance, const void *cookie);
1719 
1727 LIBCOUCHBASE_API
1728 const void *lcb_get_cookie(lcb_INSTANCE *instance);
1770 LIBCOUCHBASE_API
1771 lcb_STATUS lcb_tick_nowait(lcb_INSTANCE *instance);
1772 
1774 typedef enum {
1776  LCB_WAIT_DEFAULT = 0x00,
1777 
1785  LCB_WAIT_NOCHECK = 0x01
1786 } lcb_WAITFLAGS;
1787 
1795 LIBCOUCHBASE_API
1796 lcb_STATUS lcb_wait(lcb_INSTANCE *instance, lcb_WAITFLAGS flags);
1797 
1809 LIBCOUCHBASE_API
1810 void lcb_breakout(lcb_INSTANCE *instance);
1811 
1818 LIBCOUCHBASE_API
1819 int lcb_is_waiting(lcb_INSTANCE *instance);
1896 LIBCOUCHBASE_API
1897 void lcb_sched_enter(lcb_INSTANCE *instance);
1898 
1917 LIBCOUCHBASE_API
1918 void lcb_sched_leave(lcb_INSTANCE *instance);
1919 
1943 LIBCOUCHBASE_API
1944 void lcb_sched_fail(lcb_INSTANCE *instance);
1945 
1963 LIBCOUCHBASE_API
1964 void lcb_sched_flush(lcb_INSTANCE *instance);
1965 
1968 /* @ingroup lcb-public-api
1969  * @defgroup lcb-destroy Destroying
1970  * @brief Library destruction routines
1971  * @addtogroup lcb-destroy
1972  * @{
1973  */
1984 LIBCOUCHBASE_API
1985 void lcb_destroy(lcb_INSTANCE *instance);
1986 
1991 typedef void (*lcb_destroy_callback)(const void *cookie);
1992 
1998 LIBCOUCHBASE_API
1999 lcb_destroy_callback lcb_set_destroy_callback(lcb_INSTANCE *instance, lcb_destroy_callback);
2026 LIBCOUCHBASE_API
2027 void lcb_destroy_async(lcb_INSTANCE *instance, const void *arg);
2031 #define LCB_DATATYPE_JSON 0x01
2032 
2034 typedef enum { LCB_VALUE_RAW = 0x00, LCB_VALUE_F_JSON = 0x01, LCB_VALUE_F_SNAPPYCOMP = 0x02 } lcb_VALUEFLAGS;
2035 
2095 LIBCOUCHBASE_API
2096 lcb_STATUS lcb_cntl(lcb_INSTANCE *instance, int mode, int cmd, void *arg);
2097 
2161 LIBCOUCHBASE_API
2162 lcb_STATUS lcb_cntl_string(lcb_INSTANCE *instance, const char *key, const char *value);
2163 
2172 LIBCOUCHBASE_API
2173 lcb_STATUS lcb_cntl_setu32(lcb_INSTANCE *instance, int cmd, lcb_U32 arg);
2174 
2184 LIBCOUCHBASE_API
2185 lcb_U32 lcb_cntl_getu32(lcb_INSTANCE *instance, int cmd);
2186 
2192 LIBCOUCHBASE_API
2193 int lcb_cntl_exists(int ctl);
2194 
2252 LIBCOUCHBASE_API
2253 void lcb_refresh_config(lcb_INSTANCE *instance);
2254 
2270 #if !defined(LCB_VERSION_STRING) || defined(__LCB_DOXYGEN__)
2271 
2272 #define LCB_VERSION_STRING "unknown"
2273 #endif
2274 
2275 #if !defined(LCB_VERSION) || defined(__LCB_DOXYGEN__)
2276 
2291 #define LCB_VERSION 0x000000
2292 #endif
2293 
2294 #if !defined(LCB_VERSION_CHANGESET) || defined(__LCB_DOXYGEN__)
2295 
2296 #define LCB_VERSION_CHANGESET "0xdeadbeef"
2297 #endif
2298 
2309 LIBCOUCHBASE_API
2310 const char *lcb_get_version(lcb_U32 *version);
2311 
2313 LIBCOUCHBASE_API LCB_EXTERN_VAR const lcb_U32 lcb_version_g;
2314 
2316 #define LCB_SUPPORTS_SSL 1
2317 
2318 #define LCB_SUPPORTS_SNAPPY 2
2319 
2320 #define LCB_SUPPORTS_TRACING 3
2321 
2328 LIBCOUCHBASE_API
2329 int lcb_supports_feature(int n);
2330 
2345 LIBCOUCHBASE_API
2346 int lcb_is_redacting_logs(lcb_INSTANCE *instance);
2347 
2358 typedef struct lcb_ANALYTICS_HANDLE_ lcb_ANALYTICS_HANDLE;
2359 typedef struct lcb_DEFERRED_HANDLE_ lcb_DEFERRED_HANDLE;
2360 
2366 typedef struct lcb_RESPANALYTICS_ lcb_RESPANALYTICS;
2367 
2374 typedef void (*lcb_ANALYTICS_CALLBACK)(lcb_INSTANCE *, int, const lcb_RESPANALYTICS *);
2375 
2376 LIBCOUCHBASE_API lcb_STATUS lcb_respanalytics_status(const lcb_RESPANALYTICS *resp);
2377 LIBCOUCHBASE_API lcb_STATUS lcb_respanalytics_cookie(const lcb_RESPANALYTICS *resp, void **cookie);
2378 LIBCOUCHBASE_API lcb_STATUS lcb_respanalytics_row(const lcb_RESPANALYTICS *resp, const char **row, size_t *row_len);
2379 LIBCOUCHBASE_API lcb_STATUS lcb_respanalytics_http_response(const lcb_RESPANALYTICS *resp, const lcb_RESPHTTP **http);
2387 LIBCOUCHBASE_API lcb_STATUS lcb_respanalytics_handle(const lcb_RESPANALYTICS *resp, lcb_ANALYTICS_HANDLE **handle);
2388 LIBCOUCHBASE_API lcb_STATUS lcb_respanalytics_error_context(const lcb_RESPANALYTICS *resp,
2389  const lcb_ANALYTICS_ERROR_CONTEXT **ctx);
2390 LIBCOUCHBASE_API int lcb_respanalytics_is_final(const lcb_RESPANALYTICS *resp);
2391 LIBCOUCHBASE_API lcb_STATUS lcb_respanalytics_deferred_handle_extract(const lcb_RESPANALYTICS *resp,
2392  lcb_DEFERRED_HANDLE **handle);
2393 LIBCOUCHBASE_API lcb_STATUS lcb_deferred_handle_destroy(lcb_DEFERRED_HANDLE *handle);
2394 LIBCOUCHBASE_API lcb_STATUS lcb_deferred_handle_status(lcb_DEFERRED_HANDLE *handle, const char **status,
2395  size_t *status_len);
2396 LIBCOUCHBASE_API lcb_STATUS lcb_deferred_handle_callback(lcb_DEFERRED_HANDLE *handle, lcb_ANALYTICS_CALLBACK callback);
2397 LIBCOUCHBASE_API lcb_STATUS lcb_deferred_handle_poll(lcb_INSTANCE *instance, void *cookie, lcb_DEFERRED_HANDLE *handle);
2398 
2399 typedef struct lcb_CMDANALYTICS_ lcb_CMDANALYTICS;
2400 
2401 typedef struct lcb_INGEST_OPTIONS_ lcb_INGEST_OPTIONS;
2402 typedef enum {
2403  LCB_INGEST_METHOD_NONE = 0,
2404  LCB_INGEST_METHOD_UPSERT,
2405  LCB_INGEST_METHOD_INSERT,
2406  LCB_INGEST_METHOD_REPLACE,
2407  LCB_INGEST_METHOD__MAX
2408 } lcb_INGEST_METHOD;
2409 
2410 typedef enum {
2411 
2416  LCB_ANALYTICS_CONSISTENCY_NOT_BOUNDED = 0,
2421  LCB_ANALYTICS_CONSISTENCY_REQUEST_PLUS = 1
2422 } lcb_ANALYTICS_CONSISTENCY;
2423 
2424 typedef enum { LCB_INGEST_STATUS_OK = 0, LCB_INGEST_STATUS_IGNORE, LCB_INGEST_STATUS__MAX } lcb_INGEST_STATUS;
2425 
2426 typedef struct lcb_INGEST_PARAM_ lcb_INGEST_PARAM;
2427 
2428 typedef lcb_INGEST_STATUS (*lcb_INGEST_DATACONVERTER_CALLBACK)(lcb_INSTANCE *instance, lcb_INGEST_PARAM *param);
2429 
2430 LIBCOUCHBASE_API lcb_STATUS lcb_ingest_options_create(lcb_INGEST_OPTIONS **options);
2431 LIBCOUCHBASE_API lcb_STATUS lcb_ingest_options_destroy(lcb_INGEST_OPTIONS *options);
2432 LIBCOUCHBASE_API lcb_STATUS lcb_ingest_options_method(lcb_INGEST_OPTIONS *options, lcb_INGEST_METHOD method);
2433 LIBCOUCHBASE_API lcb_STATUS lcb_ingest_options_expiry(lcb_INGEST_OPTIONS *options, uint32_t expiration);
2434 LIBCOUCHBASE_API lcb_STATUS lcb_ingest_options_ignore_error(lcb_INGEST_OPTIONS *options, int flag);
2435 LIBCOUCHBASE_API lcb_STATUS lcb_ingest_options_data_converter(lcb_INGEST_OPTIONS *options,
2436  lcb_INGEST_DATACONVERTER_CALLBACK callback);
2437 
2438 LIBCOUCHBASE_API lcb_STATUS lcb_ingest_dataconverter_param_cookie(lcb_INGEST_PARAM *param, void **cookie);
2439 LIBCOUCHBASE_API lcb_STATUS lcb_ingest_dataconverter_param_row(lcb_INGEST_PARAM *param, const char **row,
2440  size_t *row_len);
2441 LIBCOUCHBASE_API lcb_STATUS lcb_ingest_dataconverter_param_method(lcb_INGEST_PARAM *param, lcb_INGEST_METHOD *method);
2442 LIBCOUCHBASE_API lcb_STATUS lcb_ingest_dataconverter_param_set_id(lcb_INGEST_PARAM *param, const char *id,
2443  size_t id_len, void (*id_dtor)(const char *));
2444 LIBCOUCHBASE_API lcb_STATUS lcb_ingest_dataconverter_param_set_out(lcb_INGEST_PARAM *param, const char *out,
2445  size_t out_len, void (*out_dtor)(const char *));
2446 
2447 LIBCOUCHBASE_API lcb_STATUS lcb_cmdanalytics_create(lcb_CMDANALYTICS **cmd);
2448 LIBCOUCHBASE_API lcb_STATUS lcb_cmdanalytics_destroy(lcb_CMDANALYTICS *cmd);
2449 LIBCOUCHBASE_API lcb_STATUS lcb_cmdanalytics_reset(lcb_CMDANALYTICS *cmd);
2473 LIBCOUCHBASE_API lcb_STATUS lcb_cmdanalytics_parent_span(lcb_CMDANALYTICS *cmd, lcbtrace_SPAN *span);
2480 LIBCOUCHBASE_API lcb_STATUS lcb_cmdanalytics_callback(lcb_CMDANALYTICS *cmd, lcb_ANALYTICS_CALLBACK callback);
2481 LIBCOUCHBASE_API lcb_STATUS lcb_cmdanalytics_encoded_payload(lcb_CMDANALYTICS *cmd, const char **query,
2482  size_t *query_len);
2483 LIBCOUCHBASE_API lcb_STATUS lcb_cmdanalytics_payload(lcb_CMDANALYTICS *cmd, const char *query, size_t query_len);
2484 LIBCOUCHBASE_API lcb_STATUS lcb_cmdanalytics_statement(lcb_CMDANALYTICS *cmd, const char *statement,
2485  size_t statement_len);
2486 LIBCOUCHBASE_API lcb_STATUS lcb_cmdanalytics_named_param(lcb_CMDANALYTICS *cmd, const char *name, size_t name_len,
2487  const char *value, size_t value_len);
2488 LIBCOUCHBASE_API lcb_STATUS lcb_cmdanalytics_positional_param(lcb_CMDANALYTICS *cmd, const char *value,
2489  size_t value_len);
2490 LIBCOUCHBASE_API lcb_STATUS lcb_cmdanalytics_ingest_options(lcb_CMDANALYTICS *cmd, lcb_INGEST_OPTIONS *options);
2491 LIBCOUCHBASE_API lcb_STATUS lcb_cmdanalytics_deferred(lcb_CMDANALYTICS *cmd, int deferred);
2492 LIBCOUCHBASE_API lcb_STATUS lcb_cmdanalytics_client_context_id(lcb_CMDANALYTICS *cmd, const char *value,
2493  size_t value_len);
2494 LIBCOUCHBASE_API lcb_STATUS lcb_cmdanalytics_readonly(lcb_CMDANALYTICS *cmd, int readonly);
2495 LIBCOUCHBASE_API lcb_STATUS lcb_cmdanalytics_priority(lcb_CMDANALYTICS *cmd, int priority);
2496 LIBCOUCHBASE_API lcb_STATUS lcb_cmdanalytics_consistency(lcb_CMDANALYTICS *cmd, lcb_ANALYTICS_CONSISTENCY level);
2497 LIBCOUCHBASE_API lcb_STATUS lcb_cmdanalytics_option(lcb_CMDANALYTICS *cmd, const char *name, size_t name_len,
2498  const char *value, size_t value_len);
2505 LIBCOUCHBASE_API lcb_STATUS lcb_cmdanalytics_scope_name(lcb_CMDANALYTICS *cmd, const char *scope, size_t scope_len);
2517 LIBCOUCHBASE_API lcb_STATUS lcb_cmdanalytics_scope_qualifier(lcb_CMDANALYTICS *cmd, const char *qualifier,
2518  size_t qualifier_len);
2526 LIBCOUCHBASE_API lcb_STATUS lcb_cmdanalytics_handle(lcb_CMDANALYTICS *cmd, lcb_ANALYTICS_HANDLE **handle);
2527 LIBCOUCHBASE_API lcb_STATUS lcb_cmdanalytics_timeout(lcb_CMDANALYTICS *cmd, uint32_t timeout);
2540 LIBCOUCHBASE_API lcb_STATUS lcb_analytics(lcb_INSTANCE *instance, void *cookie, const lcb_CMDANALYTICS *cmd);
2574 LIBCOUCHBASE_API lcb_STATUS lcb_analytics_cancel(lcb_INSTANCE *instance, lcb_ANALYTICS_HANDLE *handle);
2575 
2588 typedef struct lcb_SEARCH_HANDLE_ lcb_SEARCH_HANDLE;
2589 typedef struct lcb_RESPSEARCH_ lcb_RESPSEARCH;
2590 
2591 LIBCOUCHBASE_API lcb_STATUS lcb_respsearch_status(const lcb_RESPSEARCH *resp);
2592 LIBCOUCHBASE_API lcb_STATUS lcb_respsearch_cookie(const lcb_RESPSEARCH *resp, void **cookie);
2593 LIBCOUCHBASE_API lcb_STATUS lcb_respsearch_row(const lcb_RESPSEARCH *resp, const char **row, size_t *row_len);
2594 LIBCOUCHBASE_API lcb_STATUS lcb_respsearch_http_response(const lcb_RESPSEARCH *resp, const lcb_RESPHTTP **http);
2602 LIBCOUCHBASE_API lcb_STATUS lcb_respsearch_handle(const lcb_RESPSEARCH *resp, lcb_SEARCH_HANDLE **handle);
2603 LIBCOUCHBASE_API lcb_STATUS lcb_respsearch_error_context(const lcb_RESPSEARCH *resp,
2604  const lcb_SEARCH_ERROR_CONTEXT **ctx);
2605 LIBCOUCHBASE_API int lcb_respsearch_is_final(const lcb_RESPSEARCH *resp);
2606 
2607 typedef struct lcb_CMDSEARCH_ lcb_CMDSEARCH;
2608 typedef void (*lcb_SEARCH_CALLBACK)(lcb_INSTANCE *, int, const lcb_RESPSEARCH *);
2609 
2610 LIBCOUCHBASE_API lcb_STATUS lcb_cmdsearch_create(lcb_CMDSEARCH **cmd);
2611 LIBCOUCHBASE_API lcb_STATUS lcb_cmdsearch_destroy(lcb_CMDSEARCH *cmd);
2638 LIBCOUCHBASE_API lcb_STATUS lcb_cmdsearch_parent_span(lcb_CMDSEARCH *cmd, lcbtrace_SPAN *span);
2645 LIBCOUCHBASE_API lcb_STATUS lcb_cmdsearch_callback(lcb_CMDSEARCH *cmd, lcb_SEARCH_CALLBACK callback);
2646 LIBCOUCHBASE_API lcb_STATUS lcb_cmdsearch_payload(lcb_CMDSEARCH *cmd, const char *payload, size_t payload_len);
2653 LIBCOUCHBASE_API lcb_STATUS lcb_cmdsearch_handle(lcb_CMDSEARCH *cmd, lcb_SEARCH_HANDLE **handle);
2654 LIBCOUCHBASE_API lcb_STATUS lcb_cmdsearch_timeout(lcb_CMDSEARCH *cmd, uint32_t timeout);
2655 
2667 LIBCOUCHBASE_API lcb_STATUS lcb_search(lcb_INSTANCE *instance, void *cookie, const lcb_CMDSEARCH *cmd);
2675 LIBCOUCHBASE_API lcb_STATUS lcb_search_cancel(lcb_INSTANCE *instance, lcb_SEARCH_HANDLE *handle);
2734 typedef struct lcb_RESPQUERY_ lcb_RESPQUERY;
2735 
2739 typedef struct lcb_CMDQUERY_ lcb_CMDQUERY;
2743 typedef struct lcb_QUERY_HANDLE_ lcb_QUERY_HANDLE;
2744 
2751 typedef void (*lcb_QUERY_CALLBACK)(lcb_INSTANCE *, int, const lcb_RESPQUERY *);
2752 
2753 typedef enum {
2755  LCB_QUERY_CONSISTENCY_NONE = 0,
2756 
2762  LCB_QUERY_CONSISTENCY_RYOW = 1,
2763 
2765  LCB_QUERY_CONSISTENCY_REQUEST = 2,
2766 
2768  LCB_QUERY_CONSISTENCY_STATEMENT = 3
2769 } lcb_QUERY_CONSISTENCY;
2770 
2771 typedef enum {
2772  LCB_QUERY_PROFILE_OFF = 0,
2773  LCB_QUERY_PROFILE_PHASES = 1,
2774  LCB_QUERY_PROFILE_TIMINGS = 2
2775 } lcb_QUERY_PROFILE;
2776 
2777 LIBCOUCHBASE_API lcb_STATUS lcb_respquery_status(const lcb_RESPQUERY *resp);
2778 LIBCOUCHBASE_API lcb_STATUS lcb_respquery_cookie(const lcb_RESPQUERY *resp, void **cookie);
2779 LIBCOUCHBASE_API lcb_STATUS lcb_respquery_row(const lcb_RESPQUERY *resp, const char **row, size_t *row_len);
2780 LIBCOUCHBASE_API lcb_STATUS lcb_respquery_http_response(const lcb_RESPQUERY *resp, const lcb_RESPHTTP **http);
2781 LIBCOUCHBASE_API lcb_STATUS lcb_respquery_handle(const lcb_RESPQUERY *resp, lcb_QUERY_HANDLE **handle);
2782 LIBCOUCHBASE_API lcb_STATUS lcb_respquery_error_context(const lcb_RESPQUERY *resp, const lcb_QUERY_ERROR_CONTEXT **ctx);
2783 LIBCOUCHBASE_API int lcb_respquery_is_final(const lcb_RESPQUERY *resp);
2792 LIBCOUCHBASE_API lcb_STATUS lcb_cmdquery_create(lcb_CMDQUERY **cmd);
2798 LIBCOUCHBASE_API lcb_STATUS lcb_cmdquery_destroy(lcb_CMDQUERY *cmd);
2807 LIBCOUCHBASE_API lcb_STATUS lcb_cmdquery_reset(lcb_CMDQUERY *cmd);
2816 LIBCOUCHBASE_API lcb_STATUS lcb_cmdquery_encoded_payload(lcb_CMDQUERY *cmd, const char **payload, size_t *payload_len);
2843 LIBCOUCHBASE_API lcb_STATUS lcb_cmdquery_parent_span(lcb_CMDQUERY *cmd, lcbtrace_SPAN *span);
2851 LIBCOUCHBASE_API lcb_STATUS lcb_cmdquery_callback(lcb_CMDQUERY *cmd, lcb_QUERY_CALLBACK callback);
2858 LIBCOUCHBASE_API lcb_STATUS lcb_cmdquery_payload(lcb_CMDQUERY *cmd, const char *query, size_t query_len);
2865 LIBCOUCHBASE_API lcb_STATUS lcb_cmdquery_statement(lcb_CMDQUERY *cmd, const char *statement, size_t statement_len);
2872 LIBCOUCHBASE_API lcb_STATUS lcb_cmdquery_scope_name(lcb_CMDQUERY *cmd, const char *scope, size_t scope_len);
2884 LIBCOUCHBASE_API lcb_STATUS lcb_cmdquery_scope_qualifier(lcb_CMDQUERY *cmd, const char *qualifier,
2885  size_t qualifier_len);
2894 LIBCOUCHBASE_API lcb_STATUS lcb_cmdquery_named_param(lcb_CMDQUERY *cmd, const char *name, size_t name_len,
2895  const char *value, size_t value_len);
2904 LIBCOUCHBASE_API lcb_STATUS lcb_cmdquery_positional_param(lcb_CMDQUERY *cmd, const char *value, size_t value_len);
2905 LIBCOUCHBASE_API lcb_STATUS lcb_cmdquery_adhoc(lcb_CMDQUERY *cmd, int adhoc);
2906 LIBCOUCHBASE_API lcb_STATUS lcb_cmdquery_client_context_id(lcb_CMDQUERY *cmd, const char *value, size_t value_len);
2907 LIBCOUCHBASE_API lcb_STATUS lcb_cmdquery_pretty(lcb_CMDQUERY *cmd, int pretty);
2927 LIBCOUCHBASE_API lcb_STATUS lcb_cmdquery_readonly(lcb_CMDQUERY *cmd, int readonly);
2928 LIBCOUCHBASE_API lcb_STATUS lcb_cmdquery_metrics(lcb_CMDQUERY *cmd, int metrics);
2939 LIBCOUCHBASE_API lcb_STATUS lcb_cmdquery_scan_cap(lcb_CMDQUERY *cmd, int value);
2940 LIBCOUCHBASE_API lcb_STATUS lcb_cmdquery_scan_wait(lcb_CMDQUERY *cmd, uint32_t us);
2949 LIBCOUCHBASE_API lcb_STATUS lcb_cmdquery_flex_index(lcb_CMDQUERY *cmd, int value);
2950 LIBCOUCHBASE_API lcb_STATUS lcb_cmdquery_profile(lcb_CMDQUERY *cmd, lcb_QUERY_PROFILE mode);
2958 LIBCOUCHBASE_API lcb_STATUS lcb_cmdquery_pipeline_cap(lcb_CMDQUERY *cmd, int value);
2966 LIBCOUCHBASE_API lcb_STATUS lcb_cmdquery_pipeline_batch(lcb_CMDQUERY *cmd, int value);
2967 LIBCOUCHBASE_API lcb_STATUS lcb_cmdquery_max_parallelism(lcb_CMDQUERY *cmd, int value);
2976 LIBCOUCHBASE_API lcb_STATUS lcb_cmdquery_consistency(lcb_CMDQUERY *cmd, lcb_QUERY_CONSISTENCY mode);
2986 LIBCOUCHBASE_API lcb_STATUS lcb_cmdquery_consistency_token_for_keyspace(lcb_CMDQUERY *cmd, const char *keyspace,
2987  size_t keyspace_len,
2988  const lcb_MUTATION_TOKEN *token);
2989 LIBCOUCHBASE_API lcb_STATUS lcb_cmdquery_consistency_tokens(lcb_CMDQUERY *cmd, lcb_INSTANCE *instance);
2998 LIBCOUCHBASE_API lcb_STATUS lcb_cmdquery_option(lcb_CMDQUERY *cmd, const char *name, size_t name_len, const char *value,
2999  size_t value_len);
3000 LIBCOUCHBASE_API lcb_STATUS lcb_cmdquery_handle(lcb_CMDQUERY *cmd, lcb_QUERY_HANDLE **handle);
3001 LIBCOUCHBASE_API lcb_STATUS lcb_cmdquery_timeout(lcb_CMDQUERY *cmd, uint32_t timeout);
3013 LIBCOUCHBASE_API lcb_STATUS lcb_query(lcb_INSTANCE *instance, void *cookie, const lcb_CMDQUERY *cmd);
3042 LIBCOUCHBASE_API lcb_STATUS lcb_query_cancel(lcb_INSTANCE *instance, lcb_QUERY_HANDLE *handle);
3056 typedef struct lcb_RESPVIEW_ lcb_RESPVIEW;
3057 typedef struct lcb_CMDVIEW_ lcb_CMDVIEW;
3058 
3062 typedef struct lcb_VIEW_HANDLE_ lcb_VIEW_HANDLE;
3063 
3075 typedef void (*lcb_VIEW_CALLBACK)(lcb_INSTANCE *instance, int cbtype, const lcb_RESPVIEW *row);
3076 
3077 LIBCOUCHBASE_API lcb_STATUS lcb_respview_status(const lcb_RESPVIEW *resp);
3078 LIBCOUCHBASE_API lcb_STATUS lcb_respview_cookie(const lcb_RESPVIEW *resp, void **cookie);
3079 LIBCOUCHBASE_API lcb_STATUS lcb_respview_key(const lcb_RESPVIEW *resp, const char **key, size_t *key_len);
3080 LIBCOUCHBASE_API lcb_STATUS lcb_respview_doc_id(const lcb_RESPVIEW *resp, const char **doc_id, size_t *doc_id_len);
3081 LIBCOUCHBASE_API lcb_STATUS lcb_respview_row(const lcb_RESPVIEW *resp, const char **row, size_t *row_len);
3082 LIBCOUCHBASE_API lcb_STATUS lcb_respview_document(const lcb_RESPVIEW *resp, const lcb_RESPGET **doc);
3083 LIBCOUCHBASE_API lcb_STATUS lcb_respview_http_response(const lcb_RESPVIEW *resp, const lcb_RESPHTTP **http);
3084 LIBCOUCHBASE_API lcb_STATUS lcb_respview_handle(const lcb_RESPVIEW *resp, lcb_VIEW_HANDLE **handle);
3085 LIBCOUCHBASE_API lcb_STATUS lcb_respview_error_context(const lcb_RESPVIEW *resp, const lcb_VIEW_ERROR_CONTEXT **ctx);
3086 LIBCOUCHBASE_API int lcb_respview_is_final(const lcb_RESPVIEW *resp);
3087 
3088 LIBCOUCHBASE_API lcb_STATUS lcb_cmdview_create(lcb_CMDVIEW **cmd);
3089 LIBCOUCHBASE_API lcb_STATUS lcb_cmdview_destroy(lcb_CMDVIEW *cmd);
3090 LIBCOUCHBASE_API lcb_STATUS lcb_cmdview_parent_span(lcb_CMDVIEW *cmd, lcbtrace_SPAN *span);
3091 LIBCOUCHBASE_API lcb_STATUS lcb_cmdview_callback(lcb_CMDVIEW *cmd, lcb_VIEW_CALLBACK callback);
3092 LIBCOUCHBASE_API lcb_STATUS lcb_cmdview_design_document(lcb_CMDVIEW *cmd, const char *ddoc, size_t ddoc_len);
3093 LIBCOUCHBASE_API lcb_STATUS lcb_cmdview_view_name(lcb_CMDVIEW *cmd, const char *view, size_t view_len);
3094 LIBCOUCHBASE_API lcb_STATUS lcb_cmdview_option_string(lcb_CMDVIEW *cmd, const char *optstr, size_t optstr_len);
3095 LIBCOUCHBASE_API lcb_STATUS lcb_cmdview_post_data(lcb_CMDVIEW *cmd, const char *data, size_t data_len);
3096 LIBCOUCHBASE_API lcb_STATUS lcb_cmdview_include_docs(lcb_CMDVIEW *cmd, int include_docs);
3097 LIBCOUCHBASE_API lcb_STATUS lcb_cmdview_max_concurrent_docs(lcb_CMDVIEW *cmd, uint32_t num);
3098 LIBCOUCHBASE_API lcb_STATUS lcb_cmdview_no_row_parse(lcb_CMDVIEW *cmd, int flag);
3099 LIBCOUCHBASE_API lcb_STATUS lcb_cmdview_handle(lcb_CMDVIEW *cmd, lcb_VIEW_HANDLE **handle);
3100 LIBCOUCHBASE_API lcb_STATUS lcb_cmdview_timeout(lcb_CMDVIEW *cmd, uint32_t timeout);
3101 LIBCOUCHBASE_API lcb_STATUS lcb_view(lcb_INSTANCE *instance, void *cookie, const lcb_CMDVIEW *cmd);
3102 LIBCOUCHBASE_API lcb_STATUS lcb_view_cancel(lcb_INSTANCE *instance, lcb_VIEW_HANDLE *handle);
3105 /* @ingroup lcb-public-api
3106  * @defgroup lcb-subdoc Sub-Document API
3107  * @brief Experimental in-document API access
3108  * @details The sub-document API uses features from the upcoming Couchbase
3109  * 4.5 release which allows access to parts of the document. These parts are
3110  * called _sub-documents_ and can be accessed using the sub-document API
3111  *
3112  * @addtogroup lcb-subdoc
3113  * @{
3114  */
3115 
3116 typedef struct lcb_RESPSUBDOC_ lcb_RESPSUBDOC;
3117 
3118 LIBCOUCHBASE_API lcb_STATUS lcb_respsubdoc_status(const lcb_RESPSUBDOC *resp);
3119 LIBCOUCHBASE_API lcb_STATUS lcb_respsubdoc_error_context(const lcb_RESPSUBDOC *resp,
3120  const lcb_KEY_VALUE_ERROR_CONTEXT **ctx);
3121 LIBCOUCHBASE_API lcb_STATUS lcb_respsubdoc_cookie(const lcb_RESPSUBDOC *resp, void **cookie);
3122 LIBCOUCHBASE_API lcb_STATUS lcb_respsubdoc_cas(const lcb_RESPSUBDOC *resp, uint64_t *cas);
3123 LIBCOUCHBASE_API lcb_STATUS lcb_respsubdoc_key(const lcb_RESPSUBDOC *resp, const char **key, size_t *key_len);
3124 LIBCOUCHBASE_API lcb_STATUS lcb_respsubdoc_mutation_token(const lcb_RESPSUBDOC *resp, lcb_MUTATION_TOKEN *token);
3125 
3126 LIBCOUCHBASE_API size_t lcb_respsubdoc_result_size(const lcb_RESPSUBDOC *resp);
3127 LIBCOUCHBASE_API lcb_STATUS lcb_respsubdoc_result_status(const lcb_RESPSUBDOC *resp, size_t index);
3128 LIBCOUCHBASE_API lcb_STATUS lcb_respsubdoc_result_value(const lcb_RESPSUBDOC *resp, size_t index, const char **value,
3129  size_t *value_len);
3130 
3135 LIBCOUCHBASE_API int lcb_respsubdoc_is_deleted(const lcb_RESPSUBDOC *resp);
3136 
3137 typedef struct lcb_SUBDOCSPECS_ lcb_SUBDOCSPECS;
3138 
3140 #define LCB_SUBDOCSPECS_F_MKINTERMEDIATES (1u << 16u)
3141 
3143 #define LCB_SUBDOCSPECS_F_XATTRPATH (1u << 18u)
3144 
3146 #define LCB_SUBDOCSPECS_F_XATTR_MACROVALUES (1u << 19u)
3147 
3149 #define LCB_SUBDOCSPECS_F_XATTR_DELETED_OK (1u << 20u)
3150 
3151 LIBCOUCHBASE_API lcb_STATUS lcb_subdocspecs_create(lcb_SUBDOCSPECS **operations, size_t capacity);
3152 LIBCOUCHBASE_API lcb_STATUS lcb_subdocspecs_destroy(lcb_SUBDOCSPECS *operations);
3153 LIBCOUCHBASE_API lcb_STATUS lcb_subdocspecs_get(lcb_SUBDOCSPECS *operations, size_t index, uint32_t flags,
3154  const char *path, size_t path_len);
3155 LIBCOUCHBASE_API lcb_STATUS lcb_subdocspecs_exists(lcb_SUBDOCSPECS *operations, size_t index, uint32_t flags,
3156  const char *path, size_t path_len);
3157 LIBCOUCHBASE_API lcb_STATUS lcb_subdocspecs_replace(lcb_SUBDOCSPECS *operations, size_t index, uint32_t flags,
3158  const char *path, size_t path_len, const char *value,
3159  size_t value_len);
3160 LIBCOUCHBASE_API lcb_STATUS lcb_subdocspecs_dict_add(lcb_SUBDOCSPECS *operations, size_t index, uint32_t flags,
3161  const char *path, size_t path_len, const char *value,
3162  size_t value_len);
3163 LIBCOUCHBASE_API lcb_STATUS lcb_subdocspecs_dict_upsert(lcb_SUBDOCSPECS *operations, size_t index, uint32_t flags,
3164  const char *path, size_t path_len, const char *value,
3165  size_t value_len);
3166 LIBCOUCHBASE_API lcb_STATUS lcb_subdocspecs_array_add_first(lcb_SUBDOCSPECS *operations, size_t index, uint32_t flags,
3167  const char *path, size_t path_len, const char *value,
3168  size_t value_len);
3169 LIBCOUCHBASE_API lcb_STATUS lcb_subdocspecs_array_add_last(lcb_SUBDOCSPECS *operations, size_t index, uint32_t flags,
3170  const char *path, size_t path_len, const char *value,
3171  size_t value_len);
3172 LIBCOUCHBASE_API lcb_STATUS lcb_subdocspecs_array_add_unique(lcb_SUBDOCSPECS *operations, size_t index, uint32_t flags,
3173  const char *path, size_t path_len, const char *value,
3174  size_t value_len);
3175 LIBCOUCHBASE_API lcb_STATUS lcb_subdocspecs_array_insert(lcb_SUBDOCSPECS *operations, size_t index, uint32_t flags,
3176  const char *path, size_t path_len, const char *value,
3177  size_t value_len);
3178 LIBCOUCHBASE_API lcb_STATUS lcb_subdocspecs_counter(lcb_SUBDOCSPECS *operations, size_t index, uint32_t flags,
3179  const char *path, size_t path_len, int64_t delta);
3180 LIBCOUCHBASE_API lcb_STATUS lcb_subdocspecs_remove(lcb_SUBDOCSPECS *operations, size_t index, uint32_t flags,
3181  const char *path, size_t path_len);
3182 LIBCOUCHBASE_API lcb_STATUS lcb_subdocspecs_get_count(lcb_SUBDOCSPECS *operations, size_t index, uint32_t flags,
3183  const char *path, size_t path_len);
3184 
3185 typedef struct lcb_CMDSUBDOC_ lcb_CMDSUBDOC;
3186 
3187 LIBCOUCHBASE_API lcb_STATUS lcb_cmdsubdoc_create(lcb_CMDSUBDOC **cmd);
3188 LIBCOUCHBASE_API lcb_STATUS lcb_cmdsubdoc_destroy(lcb_CMDSUBDOC *cmd);
3189 LIBCOUCHBASE_API lcb_STATUS lcb_cmdsubdoc_parent_span(lcb_CMDSUBDOC *cmd, lcbtrace_SPAN *span);
3190 LIBCOUCHBASE_API lcb_STATUS lcb_cmdsubdoc_collection(lcb_CMDSUBDOC *cmd, const char *scope, size_t scope_len,
3191  const char *collection, size_t collection_len);
3192 LIBCOUCHBASE_API lcb_STATUS lcb_cmdsubdoc_key(lcb_CMDSUBDOC *cmd, const char *key, size_t key_len);
3193 LIBCOUCHBASE_API lcb_STATUS lcb_cmdsubdoc_cas(lcb_CMDSUBDOC *cmd, uint64_t cas);
3194 LIBCOUCHBASE_API lcb_STATUS lcb_cmdsubdoc_specs(lcb_CMDSUBDOC *cmd, const lcb_SUBDOCSPECS *operations);
3195 LIBCOUCHBASE_API lcb_STATUS lcb_cmdsubdoc_expiry(lcb_CMDSUBDOC *cmd, uint32_t expiration);
3196 LIBCOUCHBASE_API lcb_STATUS lcb_cmdsubdoc_durability(lcb_CMDSUBDOC *cmd, lcb_DURABILITY_LEVEL level);
3197 typedef enum {
3198  LCB_SUBDOC_STORE_REPLACE = 0,
3199  LCB_SUBDOC_STORE_UPSERT,
3200  LCB_SUBDOC_STORE_INSERT
3201 } lcb_SUBDOC_STORE_SEMANTICS;
3202 LIBCOUCHBASE_API lcb_STATUS lcb_cmdsubdoc_store_semantics(lcb_CMDSUBDOC *cmd, lcb_SUBDOC_STORE_SEMANTICS mode);
3203 LIBCOUCHBASE_API lcb_STATUS lcb_cmdsubdoc_access_deleted(lcb_CMDSUBDOC *cmd, int flag);
3204 
3209 LIBCOUCHBASE_API lcb_STATUS lcb_cmdsubdoc_create_as_deleted(lcb_CMDSUBDOC *cmd, int flag);
3210 LIBCOUCHBASE_API lcb_STATUS lcb_cmdsubdoc_timeout(lcb_CMDSUBDOC *cmd, uint32_t timeout);
3211 
3212 LIBCOUCHBASE_API lcb_STATUS lcb_subdoc(lcb_INSTANCE *instance, void *cookie, const lcb_CMDSUBDOC *cmd);
3215 /* Post-include some other headers */
3216 #ifdef __cplusplus
3217 }
3218 #endif /* __cplusplus */
3219 #endif /* LIBCOUCHBASE_COUCHBASE_H */
lcb_cmdquery_create
lcb_STATUS lcb_cmdquery_create(lcb_CMDQUERY **cmd)
Create a new lcb_CMDQUERY object.
LCB_CALLBACK_ENDURE
@ LCB_CALLBACK_ENDURE
lcb_endure3_ctxnew()
Definition: couchbase.h:479
LCB_RESP_F_NMVGEN
@ LCB_RESP_F_NMVGEN
The response was a result of a not-my-vbucket error.
Definition: couchbase.h:439
LCB_ANALYTICS_CONSISTENCY_NOT_BOUNDED
@ LCB_ANALYTICS_CONSISTENCY_NOT_BOUNDED
No consistency constraints.
Definition: couchbase.h:2416
lcb_cmdquery_pipeline_batch
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.
lcb_VIEW_CALLBACK
void(* lcb_VIEW_CALLBACK)(lcb_INSTANCE *instance, int cbtype, const lcb_RESPVIEW *row)
Callback function invoked for each row returned from the view.
Definition: couchbase.h:3075
LCB_STORE_INSERT
@ LCB_STORE_INSERT
Will cause the operation to fail if the key already exists in the cluster.
Definition: couchbase.h:862
lcb_RESPQUERY
struct lcb_RESPQUERY_ lcb_RESPQUERY
Opaque query response structure.
Definition: couchbase.h:2734
LCB_ANALYTICS_CONSISTENCY_REQUEST_PLUS
@ LCB_ANALYTICS_CONSISTENCY_REQUEST_PLUS
Strong consistency.
Definition: couchbase.h:2421
LCB_DURABILITYLEVEL_MAJORITY_AND_PERSIST_TO_ACTIVE
@ LCB_DURABILITYLEVEL_MAJORITY_AND_PERSIST_TO_ACTIVE
As majority, but additionally persisted to the active node.
Definition: couchbase.h:532
lcb_PING_SERVICE
lcb_PING_SERVICE
Type of the service.
Definition: couchbase.h:1345
lcb_cmdquery_scan_cap
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.
lcb_cntl_setu32
lcb_STATUS lcb_cntl_setu32(lcb_INSTANCE *instance, int cmd, lcb_U32 arg)
Convenience function to set a value as an lcb_U32.
LCB_CALLBACK_OBSERVE
@ LCB_CALLBACK_OBSERVE
lcb_observe3_ctxnew()
Definition: couchbase.h:477
lcb_supports_feature
int lcb_supports_feature(int n)
lcb_cmdquery_scope_name
lcb_STATUS lcb_cmdquery_scope_name(lcb_CMDQUERY *cmd, const char *scope, size_t scope_len)
Associate scope name with the query.
lcb_cmdquery_positional_param
lcb_STATUS lcb_cmdquery_positional_param(lcb_CMDQUERY *cmd, const char *value, size_t value_len)
Adds a positional argument for the query.
LCB_STORE_APPEND
@ LCB_STORE_APPEND
Rather than setting the contents of the entire document, take the value specified in lcb_CMDSTORE::va...
Definition: couchbase.h:875
lcb_ANALYTICS_CALLBACK
void(* lcb_ANALYTICS_CALLBACK)(lcb_INSTANCE *, int, const lcb_RESPANALYTICS *)
Callback to be invoked for each row.
Definition: couchbase.h:2374
lcb_RESPCOUNTER
struct lcb_RESPCOUNTER_ lcb_RESPCOUNTER
Schedule single counter operation.
Definition: couchbase.h:1144
cntl.h
Command codes for libcouchbase.
lcb_diag
lcb_STATUS lcb_diag(lcb_INSTANCE *instance, void *cookie, const lcb_CMDDIAG *cmd)
Returns diagnostics report about network connections.
LCB_WAIT_NOCHECK
@ LCB_WAIT_NOCHECK
Do not check pending operations before running the event loop.
Definition: couchbase.h:1785
lcb_sched_enter
void lcb_sched_enter(lcb_INSTANCE *instance)
Enter a scheduling context.
lcb_RESPHTTP
struct lcb_RESPHTTP_ lcb_RESPHTTP
Definition: couchbase.h:1589
lcb_cmdquery_statement
lcb_STATUS lcb_cmdquery_statement(lcb_CMDQUERY *cmd, const char *statement, size_t statement_len)
Sets the actual statement to be executed.
LCB_QUERY_CONSISTENCY_RYOW
@ LCB_QUERY_CONSISTENCY_RYOW
This is implicitly set by lcb_cmdquery_consistency_token_for_keyspace.
Definition: couchbase.h:2762
LCB_BTYPE_UNSPEC
@ LCB_BTYPE_UNSPEC
Unknown or unspecified.
Definition: couchbase.h:240
lcb_query_cancel
lcb_STATUS lcb_query_cancel(lcb_INSTANCE *instance, lcb_QUERY_HANDLE *handle)
Cancels an in-progress request.
lcb_CALLBACK_TYPE
lcb_CALLBACK_TYPE
The type of response passed to the callback.
Definition: couchbase.h:466
LCB_BTYPE_EPHEMERAL
@ LCB_BTYPE_EPHEMERAL
Data not persisted, but replicated.
Definition: couchbase.h:242
lcb_cmdsearch_handle
lcb_STATUS lcb_cmdsearch_handle(lcb_CMDSEARCH *cmd, lcb_SEARCH_HANDLE **handle)
Obtain handle to search.
lcb_AUTHENTICATOR
Opaque pointer containing credentials for the library.
lcb_cmdsubdoc_create_as_deleted
lcb_STATUS lcb_cmdsubdoc_create_as_deleted(lcb_CMDSUBDOC *cmd, int flag)
If new document created, the server will create it as a tombstone.
LCB_CALLBACK_HTTP
@ LCB_CALLBACK_HTTP
lcb_http()
Definition: couchbase.h:480
lcb_STORE_OPERATION
lcb_STORE_OPERATION
Values for lcb_CMDSTORE::operation.
Definition: couchbase.h:847
lcb_cmdquery_consistency_token_for_keyspace
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 ...
lcb_QUERY_CONSISTENCY
lcb_QUERY_CONSISTENCY
Definition: couchbase.h:2753
LCB_RESP_F_CLIENTGEN
@ LCB_RESP_F_CLIENTGEN
The response was artificially generated inside the client.
Definition: couchbase.h:436
LCB_CALLBACK_COLLECTIONS_GET_MANIFEST
@ LCB_CALLBACK_COLLECTIONS_GET_MANIFEST
lcb_getmanifest()
Definition: couchbase.h:489
lcb_IOV
structure indicating a buffer and its size
Definition: iops.h:78
lcb_cmdsearch_parent_span
lcb_STATUS lcb_cmdsearch_parent_span(lcb_CMDSEARCH *cmd, lcbtrace_SPAN *span)
Associate parent tracing span with the FTS request.
lcb_RESPSTORE
struct lcb_RESPSTORE_ lcb_RESPSTORE
Schedule a single storage request.
Definition: couchbase.h:940
lcb_VALUEFLAGS
lcb_VALUEFLAGS
Definition: couchbase.h:2034
lcb_destroy_callback
void(* lcb_destroy_callback)(const void *cookie)
Callback received when instance is about to be destroyed.
Definition: couchbase.h:1991
lcb_version_g
LCB_EXTERN_VAR const lcb_U32 lcb_version_g
Global/extern variable containing the version of the library.
Definition: couchbase.h:2313
lcb_BTYPE
lcb_BTYPE
Type of the bucket.
Definition: couchbase.h:239
lcb_query
lcb_STATUS lcb_query(lcb_INSTANCE *instance, void *cookie, const lcb_CMDQUERY *cmd)
Execute a N1QL query.
LCB_HTTP_TYPE_SEARCH
@ LCB_HTTP_TYPE_SEARCH
Search a fulltext index.
Definition: couchbase.h:1489
lcb_set_bootstrap_callback
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.
LCB_CALLBACK_OBSEQNO
@ LCB_CALLBACK_OBSEQNO
For lcb_observe_seqno3()
Definition: couchbase.h:482
lcb_tick_nowait
lcb_STATUS lcb_tick_nowait(lcb_INSTANCE *instance)
lcb_RESPTOUCH
struct lcb_RESPTOUCH_ lcb_RESPTOUCH
Spool a touch request.
Definition: couchbase.h:1292
iops.h
Public I/O integration interface.
lcb_get_callback
lcb_RESPCALLBACK lcb_get_callback(lcb_INSTANCE *instance, int cbtype)
lcb_is_redacting_logs
int lcb_is_redacting_logs(lcb_INSTANCE *instance)
Returns whether the library redacting logs for this connection instance.
LCB_HTTP_TYPE_RAW
@ LCB_HTTP_TYPE_RAW
Execute an arbitrary request against a host and port.
Definition: couchbase.h:1483
lcb_get_cookie
const void * lcb_get_cookie(lcb_INSTANCE *instance)
Retrieve the cookie associated with this instance.
lcb_wait
lcb_STATUS lcb_wait(lcb_INSTANCE *instance, lcb_WAITFLAGS flags)
Wait for completion of scheduled operations.
lcb_cmdanalytics_parent_span
lcb_STATUS lcb_cmdanalytics_parent_span(lcb_CMDANALYTICS *cmd, lcbtrace_SPAN *span)
Associate parent tracing span with the Analytics request.
lcb_HTTP_METHOD
lcb_HTTP_METHOD
HTTP Request method enumeration These just enumerate the various types of HTTP request methods suppor...
Definition: couchbase.h:1512
LCB_CALLBACK_GETCID
@ LCB_CALLBACK_GETCID
lcb_getcid()
Definition: couchbase.h:490
LCB_QUERY_CONSISTENCY_NONE
@ LCB_QUERY_CONSISTENCY_NONE
No consistency constraints.
Definition: couchbase.h:2755
lcb_INSTANCE_TYPE
lcb_INSTANCE_TYPE
Handle types.
Definition: couchbase.h:254
LCB_BTYPE_COUCHBASE
@ LCB_BTYPE_COUCHBASE
Data persisted and replicated.
Definition: couchbase.h:241
lcb_cmdquery_destroy
lcb_STATUS lcb_cmdquery_destroy(lcb_CMDQUERY *cmd)
Free the command structure.
LCB_QUERY_CONSISTENCY_STATEMENT
@ LCB_QUERY_CONSISTENCY_STATEMENT
Refresh the snapshot for each statement.
Definition: couchbase.h:2768
LCB_CALLBACK_SDLOOKUP
@ LCB_CALLBACK_SDLOOKUP
<for lcb_storedur3()
Definition: couchbase.h:484
lcb_analytics_cancel
lcb_STATUS lcb_analytics_cancel(lcb_INSTANCE *instance, lcb_ANALYTICS_HANDLE *handle)
Cancels an in-progress request.
LCB_HTTP_TYPE_VIEW
@ LCB_HTTP_TYPE_VIEW
Execute a request against the bucket.
Definition: couchbase.h:1470
lcb_cmdquery_option
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.
lcb_respsearch_handle
lcb_STATUS lcb_respsearch_handle(const lcb_RESPSEARCH *resp, lcb_SEARCH_HANDLE **handle)
Get search handle from search response.
lcb_RESPUNLOCK
struct lcb_RESPUNLOCK_ lcb_RESPUNLOCK
Unlock a previously locked item using lcb_cmdunlock.
Definition: couchbase.h:1227
lcb_respanalytics_handle
lcb_STATUS lcb_respanalytics_handle(const lcb_RESPANALYTICS *resp, lcb_ANALYTICS_HANDLE **handle)
Get handle to analytics query.
lcb_breakout
void lcb_breakout(lcb_INSTANCE *instance)
Forcefully break from the event loop.
lcb_cntl_exists
int lcb_cntl_exists(int ctl)
Determine if a specific control code exists.
lcb_RESPFLAGS
lcb_RESPFLAGS
Response flags.
Definition: couchbase.h:427
LCB_CALLBACK_DIAG
@ LCB_CALLBACK_DIAG
lcb_diag()
Definition: couchbase.h:488
LCB_CALLBACK_STORE
@ LCB_CALLBACK_STORE
lcb_store()
Definition: couchbase.h:469
lcb_get_bootstrap_status
lcb_STATUS lcb_get_bootstrap_status(lcb_INSTANCE *instance)
Gets the initial bootstrap status.
lcb_cmdanalytics_scope_name
lcb_STATUS lcb_cmdanalytics_scope_name(lcb_CMDANALYTICS *cmd, const char *scope, size_t scope_len)
Associate scope name with the query.
LCB_CALLBACK_COUNTER
@ LCB_CALLBACK_COUNTER
lcb_counter()
Definition: couchbase.h:470
lcb_connect
lcb_STATUS lcb_connect(lcb_INSTANCE *instance)
Schedule the initial connection This function will schedule the initial connection for the handle.
LCB_WAIT_DEFAULT
@ LCB_WAIT_DEFAULT
Behave like the old lcb_wait()
Definition: couchbase.h:1776
lcb_DURABILITY_LEVEL
lcb_DURABILITY_LEVEL
Definition: couchbase.h:521
lcb_bootstrap_callback
void(* lcb_bootstrap_callback)(lcb_INSTANCE *instance, lcb_STATUS err)
Bootstrap callback.
Definition: couchbase.h:351
lcb_QUERY_CALLBACK
void(* lcb_QUERY_CALLBACK)(lcb_INSTANCE *, int, const lcb_RESPQUERY *)
Callback to be invoked for each row.
Definition: couchbase.h:2751
lcb_create
lcb_STATUS lcb_create(lcb_INSTANCE **instance, const lcb_CREATEOPTS *options)
Create an instance of lcb.
lcb_CMDQUERY
struct lcb_CMDQUERY_ lcb_CMDQUERY
Opaque query command structure.
Definition: couchbase.h:2739
lcb_cmdanalytics_handle
lcb_STATUS lcb_cmdanalytics_handle(lcb_CMDANALYTICS *cmd, lcb_ANALYTICS_HANDLE **handle)
Get handle to analytics query.
LCB_RESP_F_SDSINGLE
@ LCB_RESP_F_SDSINGLE
Flag, only valid for subdoc responses, indicates that the response was processed using the single-ope...
Definition: couchbase.h:447
lcb_ANALYTICS_CONSISTENCY
lcb_ANALYTICS_CONSISTENCY
Definition: couchbase.h:2410
LCB_CALLBACK_VERBOSITY
@ LCB_CALLBACK_VERBOSITY
lcb_server_verbosity()
Definition: couchbase.h:476
kvbuf.h
Low level structures used by commands for buffers.
lcb_analytics
lcb_STATUS lcb_analytics(lcb_INSTANCE *instance, void *cookie, const lcb_CMDANALYTICS *cmd)
Execute a Analytics query.
LCB_DURABILITYLEVEL_MAJORITY
@ LCB_DURABILITYLEVEL_MAJORITY
Mutation must be replicated to (i.e.
Definition: couchbase.h:528
lcb_STATUS
lcb_STATUS
Error codes returned by the library.
Definition: error.h:209
LCB_CALLBACK_GETREPLICA
@ LCB_CALLBACK_GETREPLICA
lcb_getreplica()
Definition: couchbase.h:478
lcb_RESPANALYTICS
struct lcb_RESPANALYTICS_ lcb_RESPANALYTICS
Response for a Analytics query.
Definition: couchbase.h:2366
lcb_cmdquery_scope_qualifier
lcb_STATUS lcb_cmdquery_scope_qualifier(lcb_CMDQUERY *cmd, const char *qualifier, size_t qualifier_len)
lcb_INSTANCE
struct lcb_st lcb_INSTANCE
Library handle representing a connection to a cluster and its data buckets.
Definition: couchbase.h:35
error.h
Definition of all of the error codes used by libcouchbase.
lcb_REPLICA_MODE
lcb_REPLICA_MODE
Spool a single get-with-replica request.
Definition: couchbase.h:775
lcb_sched_leave
void lcb_sched_leave(lcb_INSTANCE *instance)
Leave the current scheduling context, scheduling the commands within the context to be flushed to the...
LCB_TYPE_CLUSTER
@ LCB_TYPE_CLUSTER
Handle for administrative access.
Definition: couchbase.h:256
LCB_CALLBACK_GET
@ LCB_CALLBACK_GET
lcb_get()
Definition: couchbase.h:468
lcb_cmdquery_encoded_payload
lcb_STATUS lcb_cmdquery_encoded_payload(lcb_CMDQUERY *cmd, const char **payload, size_t *payload_len)
Get the JSON-encoded query payload.
lcb_destroy_async
void lcb_destroy_async(lcb_INSTANCE *instance, const void *arg)
Asynchronously schedule the destruction of an instance.
LCB_CALLBACK_DEFAULT
@ LCB_CALLBACK_DEFAULT
Default callback invoked as a fallback.
Definition: couchbase.h:467
lcb_set_destroy_callback
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.
lcb_strcbtype
const char * lcb_strcbtype(int cbtype)
Returns the type of the callback as a string.
lcb_cmdquery_consistency
lcb_STATUS lcb_cmdquery_consistency(lcb_CMDQUERY *cmd, lcb_QUERY_CONSISTENCY mode)
Sets the consistency mode for the request.
lcb_cmdquery_flex_index
lcb_STATUS lcb_cmdquery_flex_index(lcb_CMDQUERY *cmd, int value)
LCB_CALLBACK_CBFLUSH
@ LCB_CALLBACK_CBFLUSH
lcb_cbflush3()
Definition: couchbase.h:481
lcb_VIEW_HANDLE
struct lcb_VIEW_HANDLE_ lcb_VIEW_HANDLE
Pointer for request instance.
Definition: couchbase.h:3062
lcb_is_waiting
int lcb_is_waiting(lcb_INSTANCE *instance)
Check if instance is blocked in the event loop.
lcb_http_cancel
lcb_STATUS lcb_http_cancel(lcb_INSTANCE *instance, lcb_HTTP_HANDLE *handle)
Cancel ongoing HTTP request.
LCB_CALLBACK_VERSIONS
@ LCB_CALLBACK_VERSIONS
lcb_server_versions()
Definition: couchbase.h:475
LCB_RESP_F_EXTDATA
@ LCB_RESP_F_EXTDATA
The response has additional internal data.
Definition: couchbase.h:443
LCB_CALLBACK_TOUCH
@ LCB_CALLBACK_TOUCH
lcb_touch()
Definition: couchbase.h:471
lcb_cmdquery_named_param
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.
lcb_set_auth
void lcb_set_auth(lcb_INSTANCE *instance, lcb_AUTHENTICATOR *auth)
Sets the authenticator object for the instance.
lcb_cmdquery_parent_span
lcb_STATUS lcb_cmdquery_parent_span(lcb_CMDQUERY *cmd, lcbtrace_SPAN *span)
Associate parent tracing span with the N1QL request.
LCB_HTTP_TYPE_MANAGEMENT
@ LCB_HTTP_TYPE_MANAGEMENT
Execute a management API request.
Definition: couchbase.h:1478
LCB_CALLBACK_UNLOCK
@ LCB_CALLBACK_UNLOCK
lcb_unlock()
Definition: couchbase.h:473
lcb_RESPGET
struct lcb_RESPGET_ lcb_RESPGET
Command for retrieving a single item.
Definition: couchbase.h:684
lcb_get_version
const char * lcb_get_version(lcb_U32 *version)
Get the version of the library.
lcb_cmdquery_payload
lcb_STATUS lcb_cmdquery_payload(lcb_CMDQUERY *cmd, const char *query, size_t query_len)
Sets the JSON-encodes query payload to be executed.
LCB_QUERY_CONSISTENCY_REQUEST
@ LCB_QUERY_CONSISTENCY_REQUEST
Refresh the snapshot for each request.
Definition: couchbase.h:2765
LCB_CALLBACK_NOOP
@ LCB_CALLBACK_NOOP
lcb_noop3()
Definition: couchbase.h:486
lcb_refresh_config
void lcb_refresh_config(lcb_INSTANCE *instance)
Force the library to refetch the cluster configuration.
lcb_set_open_callback
lcb_open_callback lcb_set_open_callback(lcb_INSTANCE *instance, lcb_open_callback callback)
Callback to be called when bucket is opened.
lcb_HTTP_TYPE
lcb_HTTP_TYPE
The type of HTTP request to execute.
Definition: couchbase.h:1465
LCB_STORE_UPSERT
@ LCB_STORE_UPSERT
The default storage mode.
Definition: couchbase.h:856
lcb_destroy
void lcb_destroy(lcb_INSTANCE *instance)
Destroy (and release all allocated resources) an instance of lcb.
auth.h
Credentials store for Couchbase.
LCB_HTTP_TYPE_ANALYTICS
@ LCB_HTTP_TYPE_ANALYTICS
Execute an Analytics Query.
Definition: couchbase.h:1492
LCB_HTTP_TYPE_QUERY
@ LCB_HTTP_TYPE_QUERY
Execute an N1QL Query.
Definition: couchbase.h:1486
LCB_DURABILITYLEVEL_PERSIST_TO_MAJORITY
@ LCB_DURABILITYLEVEL_PERSIST_TO_MAJORITY
Mutation must be persisted to (i.e.
Definition: couchbase.h:537
LCB_TYPE_BUCKET
@ LCB_TYPE_BUCKET
Handle for data access (default)
Definition: couchbase.h:255
lcb_PING_STATUS
lcb_PING_STATUS
Status of the service.
Definition: couchbase.h:1332
LCB_BTYPE_MEMCACHED
@ LCB_BTYPE_MEMCACHED
Data not persisted and not replicated.
Definition: couchbase.h:243
lcb_sched_fail
void lcb_sched_fail(lcb_INSTANCE *instance)
Fail all commands in the current scheduling context.
LCB_CALLBACK_EXISTS
@ LCB_CALLBACK_EXISTS
lcb_exists()
Definition: couchbase.h:491
lcb_search_cancel
lcb_STATUS lcb_search_cancel(lcb_INSTANCE *instance, lcb_SEARCH_HANDLE *handle)
Cancel a full-text query in progress.
lcb_cmdquery_reset
lcb_STATUS lcb_cmdquery_reset(lcb_CMDQUERY *cmd)
Reset the lcb_CMDQUERY structure so that it may be reused for a subsequent query.
lcb_sched_flush
void lcb_sched_flush(lcb_INSTANCE *instance)
Request commands to be flushed to the network.
lcb_install_callback
lcb_RESPCALLBACK lcb_install_callback(lcb_INSTANCE *instance, int cbtype, lcb_RESPCALLBACK cb)
LCB_CALLBACK_REMOVE
@ LCB_CALLBACK_REMOVE
lcb_remove()
Definition: couchbase.h:472
LCB_CALLBACK_STATS
@ LCB_CALLBACK_STATS
lcb_stats3()
Definition: couchbase.h:474
lcb_WAITFLAGS
lcb_WAITFLAGS
Flags for lcb_wait()
Definition: couchbase.h:1774
lcb_resphttp_headers
lcb_STATUS lcb_resphttp_headers(const lcb_RESPHTTP *resp, const char *const **headers)
List of key-value headers.
lcb_RESPCALLBACK
void(* lcb_RESPCALLBACK)(lcb_INSTANCE *instance, int cbtype, const lcb_RESPBASE *resp)
Callback invoked for responses.
Definition: couchbase.h:551
lcb_cmdquery_pipeline_cap
lcb_STATUS lcb_cmdquery_pipeline_cap(lcb_CMDQUERY *cmd, int value)
Sets maximum number of items each execution operator can buffer between various operators.
lcb_open
lcb_STATUS lcb_open(lcb_INSTANCE *instance, const char *bucket, size_t bucket_len)
Opens bucket.
LCB_STORE_REPLACE
@ LCB_STORE_REPLACE
Will cause the operation to fail unless the key already exists in the cluster.
Definition: couchbase.h:868
lcb_cntl
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 propertie...
LCB_RESP_F_FINAL
@ LCB_RESP_F_FINAL
No more responses are to be received for this request.
Definition: couchbase.h:429
LCB_STORE_PREPEND
@ LCB_STORE_PREPEND
Like LCB_STORE_APPEND, but prepends the new value to the existing value.
Definition: couchbase.h:880
LCB_HTTP_TYPE_PING
@ LCB_HTTP_TYPE_PING
Special pseudo-type, for ping endpoints in various services.
Definition: couchbase.h:1499
lcb_RESPREMOVE
struct lcb_RESPREMOVE_ lcb_RESPREMOVE
Spool a removal of an item.
Definition: couchbase.h:1060
LCB_CALLBACK_PING
@ LCB_CALLBACK_PING
lcb_ping3()
Definition: couchbase.h:487
LCB_RESP_F_ERRINFO
@ LCB_RESP_F_ERRINFO
The response has extra error information as value (see SDK-RFC-28).
Definition: couchbase.h:450
lcb_cntl_getu32
lcb_U32 lcb_cntl_getu32(lcb_INSTANCE *instance, int cmd)
Retrieve an lcb_U32 setting.
lcb_set_cookie
void lcb_set_cookie(lcb_INSTANCE *instance, const void *cookie)
Associate a cookie with an instance of lcb.
lcb_cntl_string
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.
lcb_cmdanalytics_scope_qualifier
lcb_STATUS lcb_cmdanalytics_scope_qualifier(lcb_CMDANALYTICS *cmd, const char *qualifier, size_t qualifier_len)
lcb_cmdquery_readonly
lcb_STATUS lcb_cmdquery_readonly(lcb_CMDQUERY *cmd, int readonly)
Marks query as read-only.
lcb_QUERY_HANDLE
struct lcb_QUERY_HANDLE_ lcb_QUERY_HANDLE
Pointer for request instance.
Definition: couchbase.h:2743
lcb_search
lcb_STATUS lcb_search(lcb_INSTANCE *instance, void *cookie, const lcb_CMDSEARCH *cmd)
Issue a full-text query.