SDK Release Notes

CXXCBC-447: This version of the SDK will not be able to connect to a cluster utilizing alternate addressing. The recommendation is to wait to upgrade to a version of the Ruby SDK that contains C++ SDK 1.0.0-dp.15 (or later).

RCBC-469: Support added for Scoped Search Indexes (#132).

RCBC-467: Added support for Vector search (#131).

RCBC-468: Support added for maxTTL value of -1 for collection 'no expiry' (#130).

RCBC-410, RCBC-458: Added support for the couchbase2 protocol (#126, #127).

RCBC-472: Ping now returns result for management service when specified in options (#134).

RCBC-463: Adedd DocumentNotLocked error to corresponds with the C++ error code couchbase::errc::key_value::document_not_locked (#128).

Ensure that truncating keys in CouchbaseStore preserves the validity of their encoding (#125).

RCBC-461: extract_expiry_time is now called in the setter instead of the constructor, so that the expiry is sent to the backend in the correct format, and there should no longer be an ArgumentError (#124).

RCBC-464: Improved stability of management tests (#133).

Migrated most of the build and test tasks to GitHub Actions.

RCBC-450: Subdoc exists was returning nil for content. It should now return the value of the content: true if result is success, or false if path-not-found (#120).

RCBC-453: Added support history retention in collection and bucket management (#119).

CXXCBC-376: Changed what 'create' and 'update' bucket operations send to the server. Unrequired BucketSettings fields are now set to optional, and are not sent unless the settings are explicitly specified. (#451).

CXXCBC-374: The SDK should now return a 'bucket_exists' error when the bucket already exists during a 'create' operation. (#449).

CXXCBC-359: 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. (#448).

CXXCBC-367, CXXCBC-370: Added history retention settings to buckets/collection management (#446).

CXXCBC-119: Return booleans for subdocument 'exists' operation, instead of error code (#444, #452).

Detect collection_not_found error in update_collection response (#450).

RCBC-441 interpret Integer as milliseconds in duration context (#110, #111).

RCBC-442 Support query with Read from Replica (#112).

RCBC-391 SDK Support for Native KV Range Scans (#113, #117).

RCBC-443 Support for Subdocument Read from Replica (#116).

RCBC-451, RCBC-451: Expose any specific lookup_in spec errors (#118).

CXXCBC-333: Fixed parsing 'resolv.conf' on Linux (#416).

CXXCBC-335: Now logging connection options for visibility (#417).

CXXCBC-343: Continue bootsrap if DNS-SRV resolution fails (#422).

CXXCBC-242: SDK Support for Native KV Range Scans (#419, #423, #424, #426, #428, #431, #432, #433, #434).

CXXCBC-339: Disable older TLS protocols (#418).

CXXCBC-346: Protocol communication can now be logged in a separate file (#425).

Couchbase::Backend.enable_protocol_logger_to_save_network_traffic_to_file("/tmp/cb.log")

CXXCBC-350: Collection ID was resolved on a per-request basis — which could result in situations where results from a single scan can originate from more than one collection. This could happen if a collection was dropped and then immediately recreated with the same name. We now resolve collection ID before performing any scan operations (#433).

RCBC-420: Implemented support for RawJsonTranscoder, RawBinaryTranscoder, and RawStringTranscoder, and checking flags when decoding document content (#93).

RCBC-427: Add missing query index management options — scope_name, collection_name, and index_name for #create_primary method. Replaced ArgumentError with InvalidArgument error when scope_name and collection_name are used in the CollectionQueryIndexManager (#92).

RCBC-436: To support LDAP authentication, always use PLAIN SASL mechanism with TLS connections (#103, CXXCBC-296).

Fix the durability level always being set to none in the C++ core (#99).

Added constructor for SearchRowLocation (#95).

Changed attr to attr_reader (#104).

CXXCBC-324: Port and network name now checked on session restart, improving performance during rebalance (#401).

CXXCBC-323: bootstrap_timeout and resolve_timeout can now be used in the connection string (#400).

CXXCBC-327: Bundled Mozilla certificates with the library (#405, #408). Source: https://curl.se/docs/caextract.html. Use the disable_mozilla_ca_certificates connection string option to disable the bundled certificates. Use the following script to inspect the certificates' metadata:

Couchbase::BUILD_INFO[:cxx_client].select{|k, _| k =~ /mozilla/}
# =>
# {:mozilla_ca_bundle_date=>"Tue Jan 10 04:12:06 2023 GMT",
#  :mozilla_ca_bundle_embedded=>true,
#  :mozilla_ca_bundle_sha256=>"fb1ecd641d0a02c01bc9036d513cb658bbda62a75e246bedbc01764560a639f0",
#  :mozilla_ca_bundle_size=>137}

Introduced connection string option dump_configuration for debugging (#398). It logs cluster configuration at trace level.

RCBC-419: Accept Couchbase::Configuration object on Couchbase::Cluster.connect (#85).

RCBC-418: Add durability to append and prepend options (#88).

RCBC-422: Cleanup search options (#89).

CXXCBC-31: Allow the use of schemaless connection strings (e.g. "cb1.example.com,cb2.example.com") (#394).

CXXCBC-318: Always try TCP if UDP fails in DNS-SRV resolver (#390).

RCBC-396: Query index management is now available on Collection class as Collection#query_indexes. scope_name and collection_name in QueryIndexManager are now deprected (#75).

Improved build with OpenSSL on CentOS 7 (#382).

CXXCBC-144: Search query on collections no longer requires you to pass in the scope name — it is inferred from the index (#379).

CXXCBC-145: Search query request, raw option added (#380).

RCBC-378: Implement change password for Management::User class. (#65)

RCBC-388: Add Configuration Profiles. At the moment one profile is defined "wan_development", and it could be applied using Options::Cluster#apply_profile. (#55)

RCBC-263: Implement legacy durability. See options :persist_to and :replicate_to of mutations. (#49)

RCBC-387: Implement replica reads with Collection#get_any_replica and Couchbase#get_all_replicas (#48)

RCBC-375: Implement log forwarding. See documentation of method Couchbase.set_logger and classes Couchbase::Utils::GenericLoggerAdapter, Couchbase::Utils::GenericLoggerAdapter (#45)

RCBC-371: Return id for *_multi results. (#40)

RCBC-393: Fix type conversion for query metrics. (#62)

RCBC-398: Add ClusterRegistry to allow custom connection string handlers. (#68)

RCBC-366: Allow to override default timeouts through Options::Cluster (#37)

RCBC-399: Add default options objects as class constants. (#69)

CXXCBC-275: Update implementation query context fields passed to the server. In future versions of the server versions it will become mandatory to specify context of the statement (bucket, scope and collection). This change ensures that both future and current server releases supported transparently.

CXXCBC-296: Force PLAIN SASL auth if TLS enabled. Using SCRAM SASL mechanisms over TLS protocol is unnecesary complication, that slows down initial connection bootstrap and potentially limits server ability to improve security and evolve credentials management.

CXXCBC-295: The get with projections opration should not fail if one of the the paths is missing in the document, because the semantics is "get the partial document" and not "get individual fields" like in lookup_in operation.

CXXCBC-294: In the Public API, if get operation requested to return expiry time, zero expiry should not be interpreted as absolute expiry timestamp (zero seconds from UNIX epoch), but rather as absense of the expiry.

CXXCBC-291: Allow to disable mutation tokens for Key/Value mutations (use enable_mutation_tokens in connection string).

Resource management and performance improvements:

Build system fixes:

Enhancements:

CXXCBC-276: Use interval from the options for config poll, which previous was hard-coded to 2.5 seconds. (#336)

CXXCBC-242: Drain waiting commands list on MCBP session close (#321)

CXXCBC-271: Fix get_all_replicas behaviour: do not propagate error if result set is not empty, while the last response has failed. (#322)

CXXCBC-142: Update SRV resolution for Windows (#303)

CXXCBC-172: Refresh DNS SRV when cluster uncontactable (#275, #290)

CXXCBC-234: Error message for bucket hibernation and update error message for authentication_failure. (#280, #285)

CXXCBC-235: Load system CAs when the trust certificate is not provided and do not fail if trust certificate is not specified (#283, #281)

CXXCBC-245: Fix encoding of durability frame (#277)

CXXCBC-246: Convert not_stored code to document_exists (#278)

CXXCBC-251: Fix snappy decompression for get_replica (#296)

CXXCBC-253: query_options not setting scope_qualifier (#300)

SDKQE-2761: Fix failures in serverless mode (#274)

Don’t log expected warnings in DNS resolver (#294)

CXXCBC-221: Support for configuration profiles (#268)

CXXCBC-218: allow to check if subdoc result field has value (#263)

CXXCBC-199: Always set kv_collection_outdated retry reason on unknown collection error (#223)

CXXCBC-203: disable clustermap nofication by default (#233)

CXXCBC-159: Increment/decrement should not have preserve_expiry (#201)

CXXCBC-55: External Tracing and Metrics support with OpenTelemetry support (#228, #231)

CXXCBC-54: Add log forwarding (#206)