couchbase 3.5.4-x86_64-linux → 3.5.5-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0628ece685b34f9f7ee01498ba5b0e2a4f1deb09db73510d408e6397bdee52cc'
-  data.tar.gz: f37f8ee86e489d2561d37b3483cdd7d798a58220da497b2cfcbf1e408cfe1751
+  metadata.gz: ff01330dbb64d21aef6197e1e7680ae260cc5759ee5c3c8a9170032746631461
+  data.tar.gz: eea9d16c8365d904da8b44490ae12723f158a93158844852e031c1827d9cbace
 SHA512:
-  metadata.gz: 0c32a49f7447326159cfb43a735313b5f5ef34c174b74c04d2dbe4307fd8c26d0044b3e269d84cc8f3f919ec6eecb16d28985be8493355af724b98ca4782b5e2
-  data.tar.gz: 222c6a0169008d898b63ff3323a22381ee5b4e09725a85f878a5f0bdb96ca464413668af01173c8b792be15b48e1a25628fd2344899b6c40114199db90170e07
+  metadata.gz: 06fb044d5787140e471266ee7c505c2a7db3654fb4b9acf884db1e5649bc450b56b08567715855f875e4e8e0d8cd13a92118a65d9126075e29d6c561063b9079
+  data.tar.gz: cc228bf988102b7bfd4561be301bd2c794d7dcbb04e90ca3639e5f16f14cf524bbb3f0595c1bc5cc18521bfaddd80a957ffd18ec50fa54b469a21f38f67116af

data/README.md

@@ -23,7 +23,7 @@ The library has been tested with MRI 3.1, 3.2 and 3.3. Supported platforms are L
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "couchbase", "3.5.4"
+gem "couchbase", "3.5.5"
 ```
 
 And then execute:

data/lib/couchbase/logger.rb

@@ -46,7 +46,7 @@ module Couchbase
 
   # Return logger associated with the library
   def self.logger
-    @logger # rubocop:disable ThreadSafety/InstanceVariableInClassMethod
+    @logger # rubocop:disable ThreadSafety/ClassInstanceVariable
   end
 
   # Associate logger with the library
@@ -67,8 +67,8 @@ module Couchbase
   #
   # @since 3.4.0
   def self.set_logger(logger, adapter_class: nil, verbose: false, level: :info)
-    @logger = logger # rubocop:disable ThreadSafety/InstanceVariableInClassMethod
-    if @logger.nil? # rubocop:disable ThreadSafety/InstanceVariableInClassMethod
+    @logger = logger # rubocop:disable ThreadSafety/ClassInstanceVariable
+    if @logger.nil? # rubocop:disable ThreadSafety/ClassInstanceVariable
       Backend.install_logger_shim(nil)
       return
     end

data/lib/couchbase/options.rb

@@ -237,10 +237,14 @@ module Couchbase
     # Options for {Collection#get_all_replicas}
     class GetAllReplicas < Base
       attr_accessor :transcoder # @return [JsonTranscoder, #decode(String, Integer)]
+      attr_accessor :read_preference # @return [Symbol]
 
       # Creates an instance of options for {Collection#get_all_replicas}
       #
       # @param [JsonTranscoder, #decode(String, Integer)] transcoder used for decoding
+      # @param [Symbol] read_preference decides how the replica nodes will be selected.
+      #  +:no_preference+:: no preference and will select any available replica. This is the default
+      #  +:selected_server_group+:: restrict to nodes in {Cluster#preferred_server_group}
       #
       # @param [Integer, #in_milliseconds, nil] timeout
       # @param [Proc, nil] retry_strategy the custom retry strategy, if set
@@ -249,12 +253,14 @@ module Couchbase
       #
       # @yieldparam [GetAllReplicas] self
       def initialize(transcoder: JsonTranscoder.new,
+                     read_preference: :no_preference,
                      timeout: nil,
                      retry_strategy: nil,
                      client_context: nil,
                      parent_span: nil)
         super(timeout: timeout, retry_strategy: retry_strategy, client_context: client_context, parent_span: parent_span)
         @transcoder = transcoder
+        @read_preference = read_preference
         yield self if block_given?
       end
 
@@ -262,6 +268,7 @@ module Couchbase
       def to_backend
         {
           timeout: Utils::Time.extract_duration(@timeout),
+          read_preference: @read_preference,
         }
       end
 
@@ -272,10 +279,14 @@ module Couchbase
     # Options for {Collection#get_any_replica}
     class GetAnyReplica < Base
       attr_accessor :transcoder # @return [JsonTranscoder, #decode(String, Integer)]
+      attr_accessor :read_preference # @return [Symbol]
 
       # Creates an instance of options for {Collection#get_any_replica}
       #
       # @param [JsonTranscoder, #decode(String, Integer)] transcoder used for decoding
+      # @param [Symbol] read_preference decides how the replica nodes will be selected.
+      #  +:no_preference+:: no preference and will select any available replica. This is the default
+      #  +:selected_server_group+:: restrict to nodes in {Cluster#preferred_server_group}
       #
       # @param [Integer, #in_milliseconds, nil] timeout
       # @param [Proc, nil] retry_strategy the custom retry strategy, if set
@@ -284,12 +295,14 @@ module Couchbase
       #
       # @yieldparam [GetAnyReplica] self
       def initialize(transcoder: JsonTranscoder.new,
+                     read_preference: :no_preference,
                      timeout: nil,
                      retry_strategy: nil,
                      client_context: nil,
                      parent_span: nil)
         super(timeout: timeout, retry_strategy: retry_strategy, client_context: client_context, parent_span: parent_span)
         @transcoder = transcoder
+        @read_preference = read_preference
         yield self if block_given?
       end
 
@@ -297,6 +310,7 @@ module Couchbase
       def to_backend
         {
           timeout: Utils::Time.extract_duration(@timeout),
+          read_preference: @read_preference,
         }
       end
 
@@ -1032,10 +1046,14 @@ module Couchbase
     # Options for {Collection#lookup_in_any_replica}
     class LookupInAnyReplica < Base
       attr_accessor :transcoder # @return [JsonTranscoder, #decode(String)]
+      attr_accessor :read_preference # @return [Symbol]
 
       # Creates an instance of options for {Collection#lookup_in_any_replica}
       #
       # @param [JsonTranscoder, #decode(String)] transcoder used for encoding
+      # @param [Symbol] read_preference decides how the replica nodes will be selected.
+      #  +:no_preference+:: no preference and will select any available replica. This is the default
+      #  +:selected_server_group+:: restrict to nodes in {Cluster#preferred_server_group}
       #
       # @param [Integer, #in_milliseconds, nil] timeout
       # @param [Proc, nil] retry_strategy the custom retry strategy, if set
@@ -1044,12 +1062,14 @@ module Couchbase
       #
       # @yieldparam [LookupIn] self
       def initialize(transcoder: JsonTranscoder.new,
+                     read_preference: :no_preference,
                      timeout: nil,
                      retry_strategy: nil,
                      client_context: nil,
                      parent_span: nil)
         super(timeout: timeout, retry_strategy: retry_strategy, client_context: client_context, parent_span: parent_span)
         @transcoder = transcoder
+        @read_preference = read_preference
         yield self if block_given?
       end
 
@@ -1057,6 +1077,7 @@ module Couchbase
       def to_backend
         {
           timeout: Utils::Time.extract_duration(@timeout),
+          read_preference: @read_preference,
         }
       end
 
@@ -1071,10 +1092,14 @@ module Couchbase
     # Options for {Collection#lookup_in_all_replicas}
     class LookupInAllReplicas < Base
       attr_accessor :transcoder # @return [JsonTranscoder, #decode(String)]
+      attr_accessor :read_preference # @return [Symbol]
 
       # Creates an instance of options for {Collection#lookup_in_all_replicas}
       #
       # @param [JsonTranscoder, #decode(String)] transcoder used for encoding
+      # @param [Symbol] read_preference decides how the replica nodes will be selected.
+      #  +:no_preference+:: no preference and will select any available replica. This is the default
+      #  +:selected_server_group+:: restrict to nodes in {Cluster#preferred_server_group}
       #
       # @param [Integer, #in_milliseconds, nil] timeout
       # @param [Proc, nil] retry_strategy the custom retry strategy, if set
@@ -1083,12 +1108,14 @@ module Couchbase
       #
       # @yieldparam [LookupInAllReplicas] self
       def initialize(transcoder: JsonTranscoder.new,
+                     read_preference: :no_preference,
                      timeout: nil,
                      retry_strategy: nil,
                      client_context: nil,
                      parent_span: nil)
         super(timeout: timeout, retry_strategy: retry_strategy, client_context: client_context, parent_span: parent_span)
         @transcoder = transcoder
+        @read_preference = read_preference
         yield self if block_given?
       end
 
@@ -1096,6 +1123,7 @@ module Couchbase
       def to_backend
         {
           timeout: Utils::Time.extract_duration(@timeout),
+          read_preference: @read_preference,
         }
       end
 
@@ -1646,6 +1674,8 @@ module Couchbase
     class Cluster
       attr_accessor :authenticator # @return [PasswordAuthenticator, CertificateAuthenticator]
 
+      attr_accessor :preferred_server_group # @return [String]
+
       attr_accessor :enable_metrics # @return [Boolean]
       attr_accessor :metrics_emit_interval # @return [nil, Integer, #in_milliseconds]
       attr_accessor :enable_tracing # @return [Boolean]
@@ -1679,6 +1709,7 @@ module Couchbase
       # Creates an instance of options for {Couchbase::Cluster.connect}
       #
       # @param [PasswordAuthenticator, CertificateAuthenticator] authenticator
+      # @param [String] preferred_server_group the server group to use for replica APIs e.g. {Collection#get_all_replicas}
       # @param [nil, Integer, #in_milliseconds] key_value_timeout default timeout for Key/Value operations, e.g. {Collection#get}
       # @param [nil, Integer, #in_milliseconds] view_timeout default timeout for View query
       # @param [nil, Integer, #in_milliseconds] query_timeout default timeout for N1QL query
@@ -1690,6 +1721,7 @@ module Couchbase
       #
       # @yieldparam [Cluster] self
       def initialize(authenticator: nil,
+                     preferred_server_group: nil,
                      enable_metrics: nil,
                      metrics_emit_interval: nil,
                      enable_tracing: nil,
@@ -1719,6 +1751,7 @@ module Couchbase
                      config_idle_redial_timeout: nil,
                      idle_http_connection_timeout: nil)
         @authenticator = authenticator
+        @preferred_server_group = preferred_server_group
         @enable_metrics = enable_metrics
         @metrics_emit_interval = metrics_emit_interval
         @enable_tracing = enable_tracing
@@ -1765,6 +1798,7 @@ module Couchbase
       def to_backend
         {
           enable_metrics: @enable_metrics,
+          preferred_server_group: @preferred_server_group,
           metrics_emit_interval: Utils::Time.extract_duration(@metrics_emit_interval),
           enable_tracing: @enable_tracing,
           orphaned_emit_interval: Utils::Time.extract_duration(@orphaned_emit_interval),
@@ -2841,6 +2875,20 @@ module Couchbase
       Scan.new(**args)
     end
 
+    # Construct {LookupInAnyReplica} options for {Collection#lookup_in_any_replica}
+    #
+    # @return [LookupInAnyReplica]
+    def LookupInAnyReplica(**args)
+      LookupInAnyReplica.new(**args)
+    end
+
+    # Construct {LookupInAllReplics} options for {Collection#lookup_in_all_replicas}
+    #
+    # @return [LookupInAllReplicas]
+    def LookupInAllReplicas(**args)
+      LookupInAllReplicas.new(**args)
+    end
+
     # rubocop:enable Naming/MethodName
   end
 end

data/lib/couchbase/version.rb

@@ -21,5 +21,5 @@ module Couchbase
   #   $ ruby -rcouchbase -e 'pp Couchbase::VERSION'
   #   {:sdk=>"3.4.0", :ruby_abi=>"3.1.0", :revision=>"416fe68e6029ec8a4c40611cf6e6b30d3b90d20f"}
   VERSION = {} unless defined?(VERSION) # rubocop:disable Style/MutableConstant
-  VERSION.update(:sdk => "3.5.4")
+  VERSION.update(:sdk => "3.5.5")
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: couchbase
 version: !ruby/object:Gem::Version
-  version: 3.5.4
+  version: 3.5.5
 platform: x86_64-linux
 authors:
 - Sergey Avseyev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-10-22 00:00:00.000000000 Z
+date: 2025-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -161,9 +161,9 @@ metadata:
   homepage_uri: https://docs.couchbase.com/ruby-sdk/current/hello-world/start-using-sdk.html
   bug_tracker_uri: https://jira.issues.couchbase.com/browse/RCBC
   mailing_list_uri: https://www.couchbase.com/forums/c/ruby-sdk
-  source_code_uri: https://github.com/couchbase/couchbase-ruby-client/tree/3.5.4
-  changelog_uri: https://github.com/couchbase/couchbase-ruby-client/releases/tag/3.5.4
-  documentation_uri: https://docs.couchbase.com/sdk-api/couchbase-ruby-client-3.5.4/index.html
+  source_code_uri: https://github.com/couchbase/couchbase-ruby-client/tree/3.5.5
+  changelog_uri: https://github.com/couchbase/couchbase-ruby-client/releases/tag/3.5.5
+  documentation_uri: https://docs.couchbase.com/sdk-api/couchbase-ruby-client-3.5.5/index.html
   github_repo: https://github.com/couchbase/couchbase-ruby-client
   rubygems_mfa_required: 'true'
 post_install_message: