SDK Release Notes

RCBC-338: Added new options for the search API. You can now add the operator and include_locations properties to all search queries.

RCBC-358, RCBC-346: Added new options for the bucket API. The SDK now allows you to configure the custom conflict resolution storage backend for new buckets.

RCBC-345: We now support preserving expiry for the query API.

RCBC-343: SSL peer is now verified by default.

Added support for Ruby 3.1.

Dropped support for Ruby 2.5 and 2.6.

RCBC-358: The SDK now initializes search locations only if they are returned by the server.

RCBC-301: Implemented metrics. This feature is enabled by default; it can be disabled in the connection string with enable_metrics=false, or programmatically:

options = Cluster::ClusterOptions.new
options.enable_metrics = false

options = Cluster::ClusterOptions.new
options.metrics_emit_interval = 60_000 # in milliseconds, default 10 minutes

RCBC-234: Implemented tracing. This feature is enabled by default; it can be disabled in the connection string with enable_tracing=false, or programmatically:

options = Cluster::ClusterOptions.new
options.enable_tracing = false

options = Cluster::ClusterOptions.new
options.orphaned_emit_interval = 600_000 # in milliseconds
options.orphaned_sample_size = 64

options.threshold_emit_interval = 600_00 # in milliseconds
options.threshold_sample_size = 64
options.key_value_threshold = 500 # in milliseconds
options.query_threshold = 1_000 # in milliseconds
options.view_threshold = 1_000 # in milliseconds
options.search_threshold = 1_000 # in milliseconds
options.analytics_threshold = 1_000 # in milliseconds
options.management_threshold = 1_000 # in milliseconds

RCBC-318: Parse and use revEpoch field in configuration for improved bucket configuration handling.

RCBC-324: Query error code 13014 is now mapped to an AuthenticationFailure exception.

RCBC-227: Remote links for analytics can now be managed from the SDK, enabling connection to an external dataset such as an AWS S3 bucket.

RCBC-283: Added Collections support for Search queries.

RCBC-311: Fixed scope qualifer encoding for analtyics to work with latest decoding.

Dropped support of Ruby 2.5.

Many smaller fixes and improvements.

RCBC-309: Allow subdocument remove operation with empty path.

RCBC-316: Fix exceptions for collections manager.

RCBC-315: Raise CasMismatch exception only when query returns code 12009 with "CAS mismatch" in message.

RCBC-298: Support preserving expiration for mutations. Collection#replace, Collection#upsert, and Collection#mutate_in methods now accept new boolean option preserve_expiry which determines whether the server will update expiration for existing documents (false by default).

collection.upsert(doc_id, {answer: 43},
    Options::Upsert(expiry: 100, preserve_expiry: true))

RCBC-317: Allow to disable snappy compression with enable_compression=false in connection string.

RCBC-314: Fixed class resolution for Analytics at scope level.

RCBC-276: Marked create_as_deleted of subdocument API as private.

RCBC-287: Updated URLs of endpoints for Collections management API.

RCBC-303: Deprecated CollectionManager#get_scope; instead the application should use CollectionManager#get_scopes and iterate/filter the results.

RCBC-313: Send collection name as value on network level for 0xbb (GET_COLLECTION_ID) command.

RCBC-302: Allow to disable configuration push from server (using enable_clustermap_notification=false in the connection string).

RCBC-307: Allow to disable unordered execution of commands (using enable_unordered_execution=false in the connection string).

The library does not keep GVL lock durng IO anymore. It releases lock when scheduling a command, and acquires it back once the command is completed. This change allows runtime to use fibers or threads, and do something useful while the operation is in progress.

RCBC-226: Add minimal durability setting in bucket manager.

RCBC-238: Refactored expiration (TTL) options:

RCBC-291: Implementation of ActiveSupport::Cache::Store interface. To enable it, put the following lines into application configuration section:

RCBC-292: Swap bytes in CAS for compatiblity. Now the value of CAS matches the representation in other services (e.g. Query).

RCBC-300: Allow the enforcement of PLAIN SASL mechanism. This is necessary when LDAP authentication is enabled, but the SDK does not use client certification to authenticate.

RCBC-237: Added collections support for analytics. Scope#analytics_query automatically sets scope qualifier. Also, it is now possible to provide custom qualifier in the options.

Status of single operation now accessible on result object of get_multi, upsert_multi, and remove_multi operations.

Error context objects now accessible on exceptions (via #context method).

RCBC-281: Implemented batching API for several data operations. (Read docs for Collection#get_multi, Collection#upsert_multi, and Collection#remove_multi).

RCBC-223, RCBC-253: Implemented ping and diagnostics APIs.

RCBC-278: Exposed getter and setter for log level, for example, Couchbase.log_level = :trace will switch logger to maximum verbosity. (details in Couchbase module documentation).

RCBC-277: Implemented append/prepend for binary collection (more in BinaryCollection documentation).

RCBC-276: Support for create_as_deleted option for Collection#mutate_in to create document in tombstone state.

Build, test, and documentation improvements.

RCBC-219, RCBC-252: Implemented diagnostics API.

RCBC-272: Allow disabling of scoring in Full-Text Search results.

RCBC-229: Geopolygon Search support.

RCBC-271: Enhanced user management for collections.

RCBC-230: Added query option for flex index.

RCBC-233: Updated eviction policy types (now it covers ephemeral buckets).

RCBC-274: Skip non-kv nodes when switching networks (fixes warnings in Cloud environment).

RCBC-266: Deprecated GetResult.expiry.

Fixed Query prepared statements cache for older servers.

Build and test system improvements.