RCBC-558, CXXCBC-980: Read a Named Replica — Collection#get_replica reads one specific replica of a document, as defined by SDK-RFC 0053.

RCBC-304, CXXCBC-845: wait_until_ready — Cluster#wait_until_ready and Bucket#wait_until_ready ping the services until they respond or the timeout elapses.

RCBC-554, CXXCBC-911: Hybrid Search Score Fusion — Options::Search#scoring controls how a hybrid search merges its FTS and vector results into one ranked list.

RCBC-582: Retry Strategy per Operation — Key-value operations honour retry_strategy:.

CXXCBC-978: Log Redaction — With log_redaction=true in the connection string, the core tags sensitive values in its log messages.

RCBC-575: ActiveSupport Cache Mutation Tracking — The mutation_tracking: store option selects which writes delete_matched and clear wait for.

Vector Search Committed — VectorSearch, VectorQuery and SearchRequest#vector_search are no longer marked uncommitted.

Platforms — Precompiled gems are published for more platforms:

RCBC-480: Windows Connections — The extension links Winsock ahead of the Ruby library on MinGW. Every connection previously failed with WSAENOTSOCK.

CXXCBC-1072, CXXCBC-1106: Management Request Encoding — Names and values passed by the application can no longer change the meaning of a management request.

CXXCBC-981: vBucket Map Bounds Check — Replica reads no longer index past the end of a vBucket map row. A row is short right after replicas are added to a bucket. Such a read could route a request to a node that does not hold the vBucket.

CXXCBC-837: MCBP Frame Bounds Check — A key-value response frame whose prefix length exceeds its body length is rejected. It previously drove the parser past the receive buffer.

CXXCBC-836: Analytics Identifier Quoting — Bucket, scope and collection names are quoted and escaped in the Analytics statements the SDK composes.

RCBC-559, RCBC-567, RCBC-586, RCBC-304: Memory Leaks on Errors and Interrupts — A failing operation no longer leaks its request, its response or its reference to the core cluster.

RCBC-568: Logger Hang — A failing Ruby logger callback no longer hangs the process.

RCBC-571, CXXCBC-913, CXXCBC-914, CXXCBC-1087: fork() Handling — The child is now notified as the child.

RCBC-564: Range Scan Use-After-Free — A scan result keeps the core cluster behind its Cluster object alive. Freeing the result after Cluster#disconnect could crash or hang the process. So could freeing both in one GC sweep.

RCBC-566: replica? Flag — GetReplicaResult#replica? now reports whether get_any_replica and get_all_replicas returned a replica. It previously returned nil over couchbase://.

RCBC-580: Raw Query and Analytics Parameters — Raw parameters reach the server as given.

RCBC-584: Raw View Parameters — Options::View#raw raised NoMethodError on every call, and stored values were never sent. Raw view parameters are now form-encoded and sent.

RCBC-583: Options Block — A block passed to an options constructor runs once, after the defaults are set. Options::Query.new { |o| o.raw("k", 1) } previously raised NoMethodError.

RCBC-574: ActiveSupport Cache After Multi-Key Writes — delete_matched and clear no longer raise NoMethodError after write_multi or delete_multi.

RCBC-569: Histogram Lock — A non-Float percentile no longer leaves HdrHistogramC locked. The next record_value previously aborted or blocked every Ruby thread. Integer percentiles are now accepted.

RCBC-573: Log Timestamps on macOS — Log times carry the correct sub-second part. On macOS it was a thousand times too small.

Windows Exit Hang — A process that loads the extension no longer hangs at exit on Windows.

**libstdc Symbol Interposition** -- Precompiled Linux gems no longer export the libstdc symbols they link statically. They interposed on the system libstdc and crashed other C extensions, such as mini_racer.

CXXCBC-984, CXXCBC-985, CXXCBC-986, CXXCBC-987, CXXCBC-1022, CXXCBC-1023, CXXCBC-1090, CXXCBC-1093: Request Completion — Several core paths no longer drop a key-value request without completing it.

CXXCBC-1039, CXXCBC-1046, CXXCBC-1048: HTTP Session Lifecycle — HTTP session shutdown is serialised and runs once. Closing a busy session no longer causes a use-after-free.

CXXCBC-1057: Client Certificate Rotation — A certificate set with Cluster#update_authenticator is used by the next HTTP request. Pooled HTTP connections previously kept the old certificate until their idle timeout.

CXXCBC-882, CXXCBC-1059: Query Error Mapping — 

CXXCBC-823, CXXCBC-839, CXXCBC-841, CXXCBC-876: Connection Management — Fixes from core 1.4.0:

CXXCBC-785, CXXCBC-787, CXXCBC-788, CXXCBC-797: Key-Value Correctness — A projected get with more than 16 paths no longer fails when a path is missing. lookup_in_all_replicas reports its paths and total failure correctly.

RCBC-554: Options::Search#disable_scoring — Replaced by scoring: SearchScoring.none, which sends the same request.

The test suite runs on Windows x64 and arm64 against CAVES.

rake compile uses the dependencies and CA bundle vendored in ext/cache.

The gem no longer ships a copy of the core’s BoringSSL patch for MinGW.

RCBC-557: Add parent_span to Ping options (#241).

Update C++ core to 1.3.3 (#245, #244, #242). Includes bug fixes for CXXCBC-839, CXXCBC-841 and CXXCBC-864.

RCBC-542: Forward the supplied CAS value to the C++ core in Append and Prepend operations, so that compare-and-swap is now honored for these mutations (#225).

RCBC-550: Access the C++ core log level through the core API instead of spdlog’s default logger (#229).

RCBC-540, RCBC-541: Updated the Protostellar protocol definitions to the latest version (#226).

Updated core to 1.3.2 (#232, #224).

RCBC-535: Upgraded the test suite to Minitest 6 (#228).

RCBC-543: Added a consistency helper for update_collection tests (#227).

RCBC-541: Added GitHub Actions testing against Couchbase Cloud Native Gateway (CNG) (#226).

Fixed rubocop Lint/SafeNavigationWithEmpty offenses (#230).

Updated GitHub Actions versions (#231).

RCBC-524, RCBC-525, RCBC-526: OpenTelemetry integration (#216, #195, #197).

RCBC-522: Support for JWT authentication (#218).

RCBC-521: The new Couchbase::Cluster#update_authenticator method allows rotating credentials (passwords or certificates) on an active cluster connection without requiring a restart (#191).

RCBC-503: New configuration settings in Couchbase::Options::Cluster to control the SDK’s internal telemetry collection, including endpoint overrides and connection backoff (#190).

RCBC-528: Migrated all Key-Value operations to use the high-performance C++ backend, ensuring feature parity and consistent behavior across Couchbase SDKs (#196).

RCBC-529: Standardized management operation options: Added parent span for search, user, and view management options, and moved to the Management::Options module, and added support for distributed tracing across administrative tasks (#192).

RCBC-527: Enhanced observability by surfacing internal C++ core timing spans (e.g., encoding, dispatch, decoding) within the Ruby span hierarchy (#210).

RCBC-536: Added cluster name and cluster uuid span/metric attributes (#202). Automatically attaches db.couchbase.cluster_name and db.couchbase.cluster_uuid to all telemetry signals.

RCBC-530: Deprecated Support for MapReduce Views (#194). MapReduce View APIs are now marked as deprecated in alignment with the Couchbase Server deprecation schedule.

RCBC-525: Fixed names of lookup_in_all_replicas and lookup_in_any_replica spans (#220).

RCBC-534: Correctly set tracer to external tracer if one is provided (#199).

Added support for Ruby 4.0 (#198).

Added inventory_with_opentelemetry example for the couchbase-opentelemetry gem (#222).

Updated core to 1.3.1 (#221, #219).

RCBC-517: Added support vector search prefilter (#180).

RCBC-518: Added way to disable enterprise analytics check programmatically (#186).

Updated core to 1.2.0 (#188, #181).

Fixed rubocop error & warnings (#185, #187).

Fix simplecov error in test helper (#184).

Github Actions:

RCBC-516: Include storage_backend in get_bucket/get_all_buckets results (#173).

RCBC-510: Added BucketSettings#num_vbuckets (#174).

RCBC-511: Updated core to pick up improved user lock/unlock error messages & logs (#177).

Updated core to 1.1.0. Release notes: C++ SDK 1.1.0.

RCBC-514: Added support for Ruby 3.4 and Linux/arm64 (#170).

RCBC-515: Enforce CMAKE_POLICY_VERSION_MINIMUM to be 3.5 for snappy and cmake 4.x (#172).

RCBC-512: Invoke fork hooks to protect SDK internal state (#165).

Updated core to 1.0.6. Release notes: C++ SDK 1.0.6.

RCBC-487: New APIs added to allow getting KV documents from a preferred server group. This feature allows the implementation of 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 (#163).

RCBC-504: Updated core and version generation (#162).

Updated core to 1.0.5. Release notes: C++ SDK 1.0.5.

Updated core to 1.0.3 (#161). Release notes: C++ SDK 1.0.3.

Added CI scripts for Rocky Linux (#159).

RCBC-496: Removed googletest from release package (#154).

Updated core to 1.0.1 (#157). Release notes: C++ SDK 1.0.1.

RCBC-489: Support added for base64 encoded vector types (#146).

RCBC-490, RCBC-492: Raise Error::InvalidArgument for invalid search queries (#145, #147, #148).

Updated core to 1.0.0 (#152). Release notes: C++ SDK 1.0.0.

RCBC-482: Only expand MutateIn macros when the relevant symbols are used as values (#141).

RCBC-476: FeatureNotAvailable message for couhbase2:// ping and diagnostics (#139).

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)