SDK Release Notes

CCBC-1653: Libcouchbase now correctly honors the timeout setting for Analytics query, when it is changed to a non-default value.

CCBC-1651: Previously, the library did not release memory of the packets that never got a chance to be flushed to the network buffer, if libcouchbase was still trying to connect sockets. This has been fixed, so that purged packets get their memory released, it thus fixes a memory leak in case of network issues.

CCBC-1646: Implemented Server groups for replica reads — allow to restrict replica set to a selected server group. This feature allows to implement network optimization when traffic cost between server groups is higher than in the local group. In this case the application might select preferred server group in the connection options, and later opt-in for local operations during replica reads.

CCBC-1555: Removed extra prefix in tapset probes.

CCBC-1598: Fixed documentation issues for cbc tools.

Fixed tests on 7.6 Server.

CCBC-1647: Server-side query timeout (status 1080) is now handled correctly.

CCBC-1643: Fixed memory leak of pending buffers in IO context.

CCBC-1645: Explicit initialization for OpenSSL is no longer required (from version 1.1+), and has been removed.

Fix build with -DLCB_DUMP_PACKETS=ON.

Fix pkg-config for MacOS.

CCBC-1636: The library was not deallocating the old packet after setting the collection ID field in the copy. mcreq_renew_packet() requires the caller to deallocate original copy, otherwise the memory will be only released by pipeline destructor. This has been addressed, and old packets are now deallocated when the collection ID is updated, freeing up memory.

CCBC-1634: Fixed the reporting of unresponsive nodes in lcb_ping().

CCBC-1630: Check collection id before storing packet to pipeline. Every time check_collection_id() is invoked, the caller should ensure that this function potentially is rewriting the packet, if it decides to insert/update an encoded collection ID. This will help to avoid problems when running in mixed mode — during an upgrade rebalance from Server 6.6 to 7.2, for instance.

CCBC-1627: Fixed bodylen value when ffextlen (flexible frame extra length) is not zero.

CCBC-1618: Updated query error codes for dynamic authenticator. This is an update to the internal interface, that allows more granular detection of stale authentication conditions for the Query Service.

Prevent full rebuild on every run of cmake. The SDK no longer renders the built timestamp into the header, but instead only uses it in the object file.

CCBC-1616: A wait_for_config check is now applied for all pipelines. Previously, the lcb_wait function would wait for the pending configuration updates, but didn’t do it if the configuration update operation was being retried. Now, the operation also will not wait for pending configuration updates, rather it will return from lcb_wait as soon as the operation completes.

CCBC-1608: Reduced the default timeout for idle HTTP connections to 1 second. The previous default (4.5 seconds) was too close to the 5-second server-side timeout, and could lead to spurious request failures.

CCBC-1615: Handle rate limit codes during bootstrap.

CCBC-1612: Improved recovery time during rebalance for upcoming Server releases. In faster failover mode:

CCBC-1611: To handle 0x0d (ECONFIG_ONLY) status code — we now treat this status code as a signal to refresh the configuration. The new or failed over nodes are set into config-only mode, where all data operations will be failed with code 0x0d. It is possible that the SDK might be using stale configuration and send requests to the node that is not part of the cluster any more, so to work around this the library will update the configuration and retry the operation.

CCBC-1610: Fixed a memory issues when setting collection id in the cluster with mixed server versions, where some of the nodes do not support collections (such as in a swap rebalance upgrade).

CCBC-1584: Updated documentation on how to use collections with pillowfight.

CCBC-1607: Fixed collection id encoding in mixed cluster, so that SDK will now work in a mixed environment of collection aware and non-collection aware Server nodes (e.g. 6.6 and 7.0 during an upgrade).

CCBC-1602: Implemented Faster Failover. This implements the set of protocol optimizations that help the SDK to save network traffic when tracking cluster topology. The feature will be only activated if the server supports it — which is planned for a future Server release.

CCBC-1603: Do not log if logger is not accessible in iotssl_log_errors.

CCBC-1599: Account NUL-byte when format IPv6 address (fixes potential invalid memory access).

CCBC-1596: Replace unsafe sprintf with snprintf.

CCBC-1597: Update threading example, reduce global state.

CCBC-1590: Always pick random node for HTTP services.

CCBC-1592: Allow to generate more randomized bodies in pillowfight.

CCBC-1595: Fix building of the subdocument operation when --subdoc switch for pillowfight was used.

pillowfight: use separate exptime switch for GET.

CCBC-1596: Fix various compiler warnings.

CCBC-1545: Handle LCB_ERR_REQUEST_CANCELED in ping callback. If the instance is being destroyed, while the operations in flight, all these operations will be cancelled with error code LCB_ERR_REQUEST_CANCELED. Ping implementation should handle this error code and not assume any of the objects (except response) to be in a valid state.

CCBC-1586: Force SASL PLAIN for TLS connections.

CCBC-1589: Apply authenticator when passed to lcb_create.

CCBC-1585: Fix build for GCC 13.

CCBC-1587: Allow to disable uninstall target.

CCBC-1583: Collections support is disabled in 3.x SDKs if the configuration does not have collections capabilities. Now, it is also disabled when a KV node does not negotiate collection support in HELLO flags. This should help with clusters in mixed mode (with both 6.x and 7.x Server versions) during an upgrade.

CCBC-1565: load system CAs when the trust certificate is not provided

CCBC-1564: update error message for authentication failure

CCBC-1568: skip logging for closed SSL IO contexts

Added cbc-bucket-list command to list all buckets.

CCBC-1522: Filter DnsQuery results on Windows by type: only use records with DNS_TYPE_SRV type.

CCBC-1521: Fixed bootstrap process when client certificate is used. We always pipeline error map request with HELLO request, and usually await for hello+error_map responses, because after that goes SASL authentication (and then optional selection of the bucket) which cannot be completely pipelined. But in case of client certificate, we might terminate bootstrap process too early if the bootstrap process does not require immediate selection of the bucket.

CCBC-1432 Support for rate limiting error codes: LCB_ERR_RATE_LIMITED and LCB_ERR_QUOTA_LIMITED.

CCBC-1514: Do not translate unknown error with "item-only" attribute into LCB_ERR_CAS_MISMATCH.

CCBC-1515: Performance optimization: replace sstream with string append(). Only if list of IO vectors supplied for value in mutation operations.

CCBC-1484: Fixed tracing tags in accordance to RFC.

CCBC-1510: Fixed key length calculation for exists/get/touch/unlock.

CCBC-1495: Fixed payload encoding in query index management helpers. Query index management helpers now explicitly declared deperecated.

CCBC-1506: Duration values now accepted golang style encoding. Connection string and lcb_cntl_string now can parse strings with duration encoded in golang style, e.g. analytics_timeout=5s42us. The result still converted into 32-bit value with microsecond resolution.

Improved test coverage, stability and documentation.

CCBC-1485: Allow disabling tracer for connected instance.

CCBC-1472: Fix handling in case of invalid responses by ensuring strict JSON parsing mode for query meta.

CCBC-1494: Disconnect logger after lcb_destroy invoked to avoid double free errors for some IO backends.

CCBC-1457: Improve error message when server enforces TLS encryption

CCBC-1489: Fixed get_and_touch to use the correct expiry.

CCBC-1487: Fixed issue with completion IO where retryq erased already sent packets.

CCBC-1488: Fixed incorrect refcounting in Connstart, where an error state followed by cancellation caused an error.

CCBC-1479: Initialize fields of custom tracer struct, fixing issues during destruction.

CCBC-1478: Fix issue where successful query returning no results triggered retry when run readonly, resulting in a timeout error.

CCBC-1216: Implement user impersonation API, for use-cases where SDK performs work on behalf of an application.

Improved test coverage and stability.

CCBC-1429: Fixed positional parameters for query/analtyics:

CCBC-1428: Clear callback upon error in lcb_search.

CCBC-1454: Fixed compiler warning in lcb_getreplica.

CCBC-1453: Refactored local name caching in lcbio_cache_local_name to simplify the code and eliminate compiler warnings.

CCBC-1451: Fixed strdup usage, in some cases the compiler might choose strdup to return int instead of char * which might lead to memory issues.

CCBC-1448: Fixed cmake macro for examples. The macro ADD_EXAMPLE now correctly updates header directories for generated target.

CCBC-1445: Always invoke callbacks for pending HTTP operations. When destroying lcb_INSTANCE make sure that all HTTP requests (views, query, search, analytics) will have their callbacks invoked.

CCBC-1438: Fixed frame size for mutations with durability. Counter, Store and Subdoc mutations were sending incorrect frame size of durability encoding, which led to rejection of the command by the server.

CCBC-1395: We no longer expose LCB_ERR_BUCKET_NOT_FOUND in operation callbacks. Instead, the operation is automatically retried until timeout.

CBCC-1280: Support for OpenTelemetry tracing.

  Tracing updated to allow for an external tracer that creates and finishes spans, adds tags, destroys spans.  Also,
spans now have the notion of being the 'outer' span.  That is the span that has all the outer span tags, and is the one
whose duration is used to determine whether or not the operation has exceeded the threshold if the
ThresholdLoggingTracer is used.

  If you pass in a parent that is an outer span, you must call `lcbtrace_span_finish` yourself. When an operation
begins, if there is no parent span passed in, or if there is but it isn't an 'outer' span, then the operation creates
the outer span itself.

See `/examples/tracing/otel_tracing.cc` for an example.

CCBC-1362: Support for metrics.

  When enabled, by default will output a histogram of latencies for various kv operations plus query, search, analytics
and view queries.

  If desired, an external metrics collector can be passed in when the instance is created, which will then be called
with latencies for each operation.  This can be used to call into an opentelemetry meter for aggregation and export.

See `/examples/metrics/otel_metrics.cc` for an example.

CCBC-1421: Allow empty path for subdocument array methods.

CCBC-1417: Deprecate CAS usage with counter operation.

CCBC-1418: Map query error 13014 to LCB_ERR_AUTHENTICATION_FAILURE.

CCBC-1357: Allow to preserve expiration with Replace, Upsert and MutateIn operations.

CCBC-1384: Allow the operations to be deferred until the instance will be connected to cluster.

CCBC-1410: Refactor dynamic authenticator. NOTE: this API still volatile and might be changed in future.

In order to improve UX and allow caller to implement credential caching the API for authenticator was revised:

instead of separate callbacks for username/password, now it uses single callback

in the callback, the caller can figure out the reason of credentials request using lcbauth_credentials_reason()

the caller can signal that it failed to retrieve credentials from external provider, and set result with lcbauth_credentials_result(). In this case the SDK will not retry the operation.

CCBC-1413: Skip SELECT_BUCKET packets waiting retry queue.

CCBC-1169: Request copy from active vbucket for get_all_replicas operation.

CCBC-1406: Fill in prepared statement handle on retry.

CCBC-1405: Remove const from command cookie.

CCBC-1402: Fix parsing JSON primitives as query rows.

Various improvements and fixes in test and build infrastructure

CCBC-1395: We no longer expose LCB_ERR_BUCKET_NOT_FOUND in operation callbacks. Instead, the operation is automatically retried until timeout.

CCBC-1398: Parse and use revEpoch from configuration in order to allow the server to handle special cases of failover scenarios.

CCBC-1399: Implement retry backoff for query requests. Instead of retrying requests immediately, use backoff period returned by retry strategy.

CCBC-1400: Fill collection name when retrying collection resolution to avoid misrouting requests to default collection.

CCBC-1397: Reset list of "used" nodes when retrying query to allow reusing endpoints.

CCBC-1401: Fix special error message detection for Query requests. In addition to reacting on the error codes from query service, the library also scans error messages for particular sub-strings to decide whether retry is necessary.

CCBC-861: Purge pipelines on lcb_destroy. In order to avoid resource leaks, the library purges all pending (or waiting) commands from the pipelines upon destruction.

Fix cbc-proxy tool.

Upgrade snappy to 1.1.8

CCBC-1395: We no longer expose LCB_ERR_BUCKET_NOT_FOUND in operation callbacks. Instead, the operation is automatically retried until timeout.

CCBC-1373: Do not send collection in the key. Sending collection specification in both key and body breaks protocol, and the server will close the socket.

CCBC-1396: Fix recalculaton of key length for alternative packets.

CCBC-1395: Parse configuration revision as int64_t.

MB-45759: Allow building libcouchbase with external Snappy.

CCBC-1330: Detect unknown collection during "populate" phase of cbc-pillowfight.

CCBC-1386: Remove legacy options for cbc-bucket-create.

CCBC-1382: Return LCB_ERR_CAS_MISMATCH for operations with with REPLACE semantics instead of LCB_ERR_DOCUMENT_EXISTS.

CCBC-1389: Fixed default collection parsing.

CCBC-1383: Fixed protocol magic for durable remove. When durability level provided, the remove command should use "alternative request" as protocol magic byte.

CCBC-1381: Protocol changes for PROTOCOL_BINARY_CMD_COLLECTIONS_GET_CID (0xbb). The server now expects collection specification passed as a command value during collection ID resolution.

CCBC-1385: Restrict cases when Query error code 12009 is converted to LCB_ERR_CAS_MISMATCH. Now it returned only in cases where concurrency problem detected by query engine. Otherwise LCB_ERR_DML_FAILURE will be used.

CCBC-1373: Return LCB_ERR_TIMEOUT if the library is not able to resolve collection identifier. Previously either LCB_ERR_COLLECTION_NOT_FOUND or LCB_ERR_SCOPE_NOT_FOUND might be returned.

CCBC-1109: When dynamic authenticator is being used, the library will retry Query on error code 13014 (datastore.couchbase.insufficient_credentials).

CCBC-1392: Query commands now invoke retry strategy hook to make decision about retrying.

CCBC-1379: Error map could be disabled now using LCB_CNTL_ENABLE_ERRMAP or in the connection string with enable_errmap=false.

CCBC-1269: Expose setting for N1QL grace period. This is a port of CCBC-1122. The example below will add extra 100ms to each N1QL query:

lcb_cntl_setu32(instance, LCB_CNTL_QUERY_GRACE_PERIOD, 100000);

CCBC-1376: Propagate scope qualifier to prepared query statements.

CCBC-1283: Added analytics support for scopes.

CCBC-1374: Reintroduce input error classification macro.

CCBC-1375: Translate query errors when scope/collection missing.

CCBC-1366: Do not cache bucket-less configurations.

CCBC-1363: Allow using parent project’s hdr_histogram_static target.

CCBC-1361: Allow "_default._default" collection for pre-collections servers.

MB-42884: Correctly define FILEVERSION for libcouchbase.dll.

CCBC-1351: Option to render cbc-ping output as a table.

CCBC-1323: Return LCB_ERR_DOCUMENT_EXISTS only for insert operation.

CCBC-1346: Return LCB_ERR_DOCUMENT_LOCKED for locked documents.

CCBC-1350: Implemented an option for cbc-n1qlback to control prepared/adhoc switch.

CCBC-1345: Ensure all KV sockets select bucket on lcb_open.

CCBC-1348: Bucket name now included in diag report.

CCBC-1308: Defined FATAL and TRANSIENT classes for errors. Also defines corresponding macros for easy access LCB_ERROR_IS_TRANSIENT and LCB_ERROR_IS_FATAL.

CCBC-1342: Check if collections supported by server before using them. Specifying a non-default collection on an operation against servers which do not support collections will now return a FeatureNotSupported error.

CCBC-1334: Preserve status of KV protocol response for retry queue.

CCBC-1339: Do not relocate get with replica on failover. The library should not relocate replica reads when new configuration applied.

CCBC-1344: Consume response after retried command to avoid logging the command as "timed out".

CCBC-1343: Do not schedule NotMyVbucket immediately by default and use retry strategy instead.

CCBC-1335: Fixed next timeout computation on requesting config using operation_timeout instead of config_node_timeout.

CCBC-1337: Expose setting for to control default search timeout.

CCBC-1331: Fixed error at bootstrap callback, now it returns original error code, that caused the bootstrap failure.

CCBC-1333: Allow setting lcb_cmdget_locktime to zero to use server default time.

CCBC-1324: Defined HTTP type for Eventing management.

Retry operations when the node is not ready.

Report LCB_ERR_BUCKET_NOT_FOUND if Key/Value service is not configured.

Update error codes for Query. Translate code 4300 to LCB_ERR_PLANNING_FAILURE and 5000 to LCB_ERR_INTERNAL_SERVER_FAILURE by default.

Fix collection validation, it should pass empty string as valid collection specification element.

Remove verbosity and mcversions commands. These parts of API are non-standard and volatile.

Bundle HdrHistogram_c v0.11.2 and allow to fall back to it.

CCBC-1311: Implemented create_as_deleted subdoc feature.

CCBC-1263: Updated ping to report Analytics as Analytics Service instead of Query.

CCBC-1175: Allow to specify timeout for lcb_ping.

CCBC-1262: Added accessor for report_id in ping report.

CCBC-1176: Renamed "scope" to "namespace" in ping report (also deprecated lcb_respping_result_scope in favour to lcb_respping_result_namespace).

CCBC-1261: Set namespace length of service in ping report to zero if not applicable.

CCBC-1194: Added extra checks for socket state in lcb_diag to avoid invalid access issues.

CCBC-1314: Extra checks for socket state in lcb_ping to avoid invalid access issues.

CCBC-1316: Fixed two-step bootstrap (lcb_connect + lcb_open) for memcached bucket.

CCBC-1307: The SDK now allows the selection of any mechanisms for SASL regardless of the network protocol being usedm although by default the SDK will try to avoid downgrading to PLAIN on non-TLS connections. Also the change allows users to specify a list of preferred mechanisms instead of only one (through the use of a comma in the value of the sasl_mech_force connection string option).

CCBC-1276: Addded flex (FTS) index usage to query options.

CCBC-1312: Fixed return values for lcb_cmdquery_scope_*.

CCBC-1313: Replaced std::random_shuffle with std::shuffle. fixing build of cbc-n1qlback tool.

CCBC-1281: Implemented scope qualifier for queries.

CCBC-1301: Expose cmake option to help dissect TLS traffic.

Detect configuration change when replica indexes changed.

Binary packages for Ubuntu 20.04 LTS (Focal Fossa)

CCBC-1265: Enabled out of order execution by default.

CCBC-1189: The SDK now validate collection and scope names early. The library will return an error if the collection name is not valid, without sending a command to the server.

CCBC-1278: Fixed stripping payload over TLS connection. The library might propagate zero return code from recv() even when previous calls of recv() successfully transferred bytes to SSL context. In this case we might lose these trailing bytes and just close the socket.

CCBC-1264: Fixed calculating key size when durability level specified.

CCBC-1258: Fixed port order in vbucket diff info message.

CCBC-1274: Fixed pointer casting in HTTP callback of cbc tool.

CCBC-1167: Fixed tests build on MacOS.

CCBC-1248: The SDK will now always request error map feature and send HELLO message to speedup bootstrap.

Implemented tick for IOCP plugin on Windows.

Improved build on Windows (fixed static build, and PDB installation).

Fixed collections issues for future server release.

CCBC-1200: LCB will now retry bootstrap on missing bucket error until timeout. Bootstrap timeout is controlled by "config_total_timeout" in connection string or LCB_CNTL_CONFIGURATION_TIMEOUT.

CCBC-1190: When performing an operation immediately after bucket creation, the server returns TMPFAIL and libcouchbase bubbled this up rather than restarting. Now fixed so LCB automatic retries for temporary failures from the server.

CCBC-1158: Reduced retrying on unknown collection to a sensible level.

CCBC-1254: It’s now possible to use a separate option for default timeout of Analytics queries (connection string "analytics_timeout").

CCBC-1178: It is now no longer possible to (illigally) set CAS for upsert and insert operations.

CCBC-1156: Fixed enum value for analytics type of HTTP request.

CCBC-1251: No longer log error when using GCCCP on pre-6.5 Couchbase Server.

CCBC-1234: Fixed SRV resolution to work with large record sizes.

CCBC-1222: Tracing thresholds for query and search fixed in connection strings: tracing_threshold_search and tracing_threshold_query.

CCBC-1187: lcb_respexists_is_found can no longer return true for deleted documents.

CCBC-1233: Updated RTO to independently specify operation_name.

CCBC-1205: Do not include trailing zero for endpoint length for KV context.

CCBC-1215: Fixed segfault in exists calls.

CCBC-1218: Fixed intermittent segfault in client durable store.

Documentation issues addressed (CCBC-1240, CCBC-1241, CCBC-1243, CCBC-1245)