couchbase 3.4.3 → 3.4.5

data/lib/couchbase/management/collection_manager.rb

@@ -38,6 +38,8 @@ module Couchbase
             super
             yield self if block_given?
           end
+
+          DEFAULT = GetAllScopes.new.freeze
         end
 
         # Options for {CollectionManager#create_scope}
@@ -57,6 +59,8 @@ module Couchbase
             super
             yield self if block_given?
           end
+
+          DEFAULT = CreateScope.new.freeze
         end
 
         # Options for {CollectionManager#drop_scope}
@@ -76,6 +80,8 @@ module Couchbase
             super
             yield self if block_given?
           end
+
+          DEFAULT = DropScope.new.freeze
         end
 
         # Options for {CollectionManager#create_collection}
@@ -95,6 +101,29 @@ module Couchbase
             super
             yield self if block_given?
           end
+
+          DEFAULT = CreateCollection.new.freeze
+        end
+
+        # Options for {CollectionManager#update_collection}
+        class UpdateCollection < ::Couchbase::Options::Base
+          # Creates an instance of options for {CollectionManager#update_collection}
+          #
+          # @param [Integer, #in_milliseconds, nil] timeout the time in milliseconds allowed for the operation to complete
+          # @param [Proc, nil] retry_strategy the custom retry strategy, if set
+          # @param [Hash, nil] client_context the client context data, if set
+          # @param [Span, nil] parent_span if set holds the parent span, that should be used for this request
+          #
+          # @yieldparam [UpdateCollection] self
+          def initialize(timeout: nil,
+                         retry_strategy: nil,
+                         client_context: nil,
+                         parent_span: nil)
+            super
+            yield self if block_given?
+          end
+
+          DEFAULT = UpdateCollection.new.freeze
         end
 
         # Options for {CollectionManager#drop_collection}
@@ -114,6 +143,8 @@ module Couchbase
             super
             yield self if block_given?
           end
+
+          DEFAULT = DropCollection.new.freeze
         end
 
         # rubocop:disable Naming/MethodName constructor shortcuts
@@ -184,6 +215,8 @@ module Couchbase
               CollectionSpec.new do |collection|
                 collection.name = c[:name]
                 collection.scope_name = s[:name]
+                collection.max_expiry = c[:max_expiry]
+                collection.history = c[:history]
               end
             end
           end
@@ -232,29 +265,88 @@ module Couchbase
       end
 
       # Creates a new collection
+      # @overload create_collection(scope_name, collection_name, settings = CreateCollectionSettings::DEFAULT,
+      #  options = Options::Collection::CreateCollection::DEFAULT)
+      #   @param [String] scope_name the name of the scope the collection will be created in
+      #   @param [String] collection_name the name of the collection to be created
+      #   @param [CreateCollectionSettings] settings settings for the new collection
+      #   @param [Options::Collection::CreateCollection] options
       #
-      # @param [CollectionSpec] collection specification of the collection
-      # @param [Options::Collection::CreateCollection] options
+      # @overload create_collection(collection, options = Options::Collection::CreateCollection)
+      #   @param [CollectionSpec] collection specification of the collection
+      #   @param [Options::Collection::CreateCollection] options
+      #
+      #   @deprecated Use +#create_collection(scope_name, collection_name, settings, options)+ instead
       #
       # @return void
       #
       # @raise [ArgumentError]
-      # @raise [Error::CollectionExist]
+      # @raise [Error::CollectionExists]
+      # @raise [Error::ScopeNotFound]
+      def create_collection(*args)
+        if args[0].is_a?(CollectionSpec)
+          collection = args[0]
+          options = args[1] || Options::Collection::CreateCollection::DEFAULT
+          settings = CreateCollectionSettings.new(max_expiry: collection.max_expiry, history: collection.history)
+
+          warn "Calling create_collection with a CollectionSpec object has been deprecated, supply scope name, " \
+               "collection name and optionally a CreateCollectionSettings instance"
+
+          @backend.collection_create(@bucket_name, collection.scope_name, collection.name, settings.to_backend, options.to_backend)
+        else
+          scope_name = args[0]
+          collection_name = args[1]
+          settings = args[2] || CreateCollectionSettings::DEFAULT
+          options = args[3] || Options::Collection::CreateCollection::DEFAULT
+          @backend.collection_create(@bucket_name, scope_name, collection_name, settings.to_backend, options.to_backend)
+        end
+      end
+
+      # Updates the settings of an existing collection
+      #
+      # @param [String] scope_name the name of the scope the collection is in
+      # @param [String] collection_name the name of the collection to be updated
+      # @param [UpdateCollectionSettings] settings the settings that should be updated
+      #
+      # @raise [ArgumentError]
+      # @raise [Error::CollectionNotFound]
       # @raise [Error::ScopeNotFound]
-      def create_collection(collection, options = Options::Collection::CreateCollection.new)
-        @backend.collection_create(@bucket_name, collection.scope_name, collection.name, collection.max_expiry, options.to_backend)
+      def update_collection(scope_name, collection_name, settings = UpdateCollectionSettings::DEFAULT,
+                            options = Options::Collection::UpdateCollection::DEFAULT)
+        @backend.collection_update(@bucket_name, scope_name, collection_name, settings.to_backend, options.to_backend)
       end
 
       # Removes a collection
+      # @overload drop_collection(scope_name, collection_name, settings = CreateCollectionSettings::DEFAULT,
+      #   options = Options::Collection::CreateCollection::DEFAULT)
+      #   @param [String] scope_name the name of the scope the collection is in
+      #   @param [String] collection_name the name of the collection to be removed
       #
-      # @param [CollectionSpec] collection specification of the collection
-      # @param [Options::Collection::DropCollection] options
+      # @overload drop_collection(collection, options = Options::Collection::CreateCollection)
+      #   @param [CollectionSpec] collection specification of the collection
+      #   @param [Options::Collection::CreateCollection] options
+      #
+      #   @deprecated Use +#drop_collection(scope_name, collection_name, options)+ instead
       #
       # @return void
       #
+      # @raise [ArgumentError]
       # @raise [Error::CollectionNotFound]
-      def drop_collection(collection, options = Options::Collection::DropCollection.new)
-        @backend.collection_drop(@bucket_name, collection.scope_name, collection.name, options.to_backend)
+      # @raise [Error::ScopeNotFound]
+      def drop_collection(*args)
+        if args[0].is_a?(CollectionSpec)
+          collection = args[0]
+          options = args[1] || Options::Collection::CreateCollection::DEFAULT
+
+          warn "Calling drop_collection with a CollectionSpec object has been deprecated, supply scope name and collection name"
+
+          @backend.collection_drop(@bucket_name, collection.scope_name, collection.name, options.to_backend)
+        else
+          scope_name = args[0]
+          collection_name = args[1]
+          options = args[2] || Options::Collection::CreateCollection::DEFAULT
+          @backend.collection_drop(@bucket_name, scope_name, collection_name, options.to_backend)
+        end
       end
 
       # @deprecated use {CollectionManager#get_all_scopes} instead
@@ -289,6 +381,60 @@ module Couchbase
       DropCollectionOptions = ::Couchbase::Management::Options::Collection::DropCollection
     end
 
+    class CreateCollectionSettings
+      # @return [Integer, nil] time in seconds of the maximum expiration time for new documents in the collection
+      # (set to +nil+ to disable it)
+      attr_accessor :max_expiry
+
+      # @return [Boolean, nil] whether history retention override should be enabled in the collection (set to +nil+ to
+      # default to the bucket-level setting)
+      attr_accessor :history
+
+      def initialize(max_expiry: nil, history: nil)
+        @max_expiry = max_expiry
+        @history = history
+
+        yield self if block_given?
+      end
+
+      # @api private
+      def to_backend
+        {
+          max_expiry: @max_expiry,
+          history: @history,
+        }
+      end
+
+      DEFAULT = CreateCollectionSettings.new.freeze
+    end
+
+    class UpdateCollectionSettings
+      # @return [Integer, nil] time in seconds of the maximum expiration time for new documents in the collection
+      # (set to +nil+ to disable it)
+      attr_accessor :max_expiry
+
+      # @return [Boolean, nil] whether history retention override should be enabled in the collection (set to +nil+ to
+      # default to the bucket-level setting)
+      attr_accessor :history
+
+      def initialize(max_expiry: nil, history: nil)
+        @max_expiry = max_expiry
+        @history = history
+
+        yield self if block_given?
+      end
+
+      # @api private
+      def to_backend
+        {
+          max_expiry: @max_expiry,
+          history: @history,
+        }
+      end
+
+      DEFAULT = UpdateCollectionSettings.new.freeze
+    end
+
     class ScopeSpec
       # @return [String] name of the scope
       attr_accessor :name
@@ -312,6 +458,9 @@ module Couchbase
       # @return [Integer] time in seconds of the expiration for new documents in the collection (set to +nil+ to disable it)
       attr_accessor :max_expiry
 
+      # @return [Boolean, nil] whether history retention is enabled for this collection
+      attr_accessor :history
+
       # @yieldparam [CollectionSpec] self
       def initialize
         yield self if block_given?

data/lib/couchbase/options.rb

@@ -1026,6 +1026,151 @@ module Couchbase
       DEFAULT = LookupIn.new.freeze
     end
 
+    # Options for {Collection#lookup_in_any_replica}
+    class LookupInAnyReplica < Base
+      attr_accessor :transcoder # @return [JsonTranscoder, #decode(String)]
+
+      # Creates an instance of options for {Collection#lookup_in_any_replica}
+      #
+      # @param [JsonTranscoder, #decode(String)] transcoder used for encoding
+      #
+      # @param [Integer, #in_milliseconds, nil] timeout
+      # @param [Proc, nil] retry_strategy the custom retry strategy, if set
+      # @param [Hash, nil] client_context the client context data, if set
+      # @param [Span, nil] parent_span if set holds the parent span, that should be used for this request
+      #
+      # @yieldparam [LookupIn] self
+      def initialize(transcoder: JsonTranscoder.new,
+                     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
+        yield self if block_given?
+      end
+
+      # @api private
+      def to_backend
+        {
+          timeout: Utils::Time.extract_duration(@timeout),
+        }
+      end
+
+      # @api private
+      # @return [Boolean]
+      attr_accessor :access_deleted
+
+      # @api private
+      DEFAULT = LookupInAnyReplica.new.freeze
+    end
+
+    # Options for {Collection#lookup_in_all_replicas}
+    class LookupInAllReplicas < Base
+      attr_accessor :transcoder # @return [JsonTranscoder, #decode(String)]
+
+      # Creates an instance of options for {Collection#lookup_in_all_replicas}
+      #
+      # @param [JsonTranscoder, #decode(String)] transcoder used for encoding
+      #
+      # @param [Integer, #in_milliseconds, nil] timeout
+      # @param [Proc, nil] retry_strategy the custom retry strategy, if set
+      # @param [Hash, nil] client_context the client context data, if set
+      # @param [Span, nil] parent_span if set holds the parent span, that should be used for this request
+      #
+      # @yieldparam [LookupInAllReplicas] self
+      def initialize(transcoder: JsonTranscoder.new,
+                     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
+        yield self if block_given?
+      end
+
+      # @api private
+      def to_backend
+        {
+          timeout: Utils::Time.extract_duration(@timeout),
+        }
+      end
+
+      # @api private
+      DEFAULT = LookupInAllReplicas.new.freeze
+    end
+
+    # Options for {Collection#scan}
+    class Scan < Base
+      attr_accessor :ids_only # @return [Boolean]
+      attr_accessor :transcoder # @return [JsonTranscoder, #decode(String)]
+      attr_accessor :mutation_state # @return [MutationState, nil]
+      attr_accessor :batch_byte_limit # @return [Integer, nil]
+      attr_accessor :batch_item_limit # @return [Integer, nil]
+      attr_accessor :concurrency # @return [Integer, nil]
+
+      # Creates an instance of options for {Collection#scan}
+      #
+      # @param [Boolean] ids_only if set to true, the content of the documents is not included in the results
+      # @param [JsonTranscoder, #decode(String)] transcoder used for decoding
+      # @param [MutationState, nil] mutation_state sets the mutation tokens this scan should be consistent with
+      # @param [Integer, nil] batch_byte_limit allows to limit the maximum amount of bytes that are sent from the server
+      #   to the client on each partition batch, defaults to 15,000
+      # @param [Integer, nil] batch_item_limit allows to limit the maximum amount of items that are sent from the server
+      #   to the client on each partition batch, defaults to 50
+      # @param [Integer, nil] concurrency specifies the maximum number of partitions that can be scanned concurrently,
+      #   defaults to 1
+      #
+      # @param [Integer, #in_milliseconds, nil] timeout
+      # @param [Proc, nil] retry_strategy the custom retry strategy, if set
+      # @param [Hash, nil] client_context the client context data, if set
+      # @param [Span, nil] parent_span if set holds the parent span, that should be used for this request
+      #
+      # @yieldparam [LookupIn] self
+      def initialize(ids_only: false,
+                     transcoder: JsonTranscoder.new,
+                     mutation_state: nil,
+                     batch_byte_limit: nil,
+                     batch_item_limit: nil,
+                     concurrency: nil,
+                     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)
+        @ids_only = ids_only
+        @transcoder = transcoder
+        @mutation_state = mutation_state
+        @batch_byte_limit = batch_byte_limit
+        @batch_item_limit = batch_item_limit
+        @concurrency = concurrency
+        yield self if block_given?
+      end
+
+      # Sets the mutation tokens this query should be consistent with
+      #
+      # @note overrides consistency level set by {#scan_consistency=}
+      #
+      # @param [MutationState] mutation_state the mutation state containing the mutation tokens
+      def consistent_with(mutation_state)
+        @mutation_state = mutation_state
+      end
+
+      # @api private
+      def to_backend
+        {
+          timeout: Utils::Time.extract_duration(@timeout),
+          ids_only: @ids_only,
+          mutation_state: @mutation_state.to_a,
+          batch_byte_limit: @batch_byte_limit,
+          batch_item_limit: @batch_item_limit,
+          concurrency: @concurrency,
+        }
+      end
+
+      DEFAULT = Scan.new.freeze
+    end
+
     # Options for {BinaryCollection#append}
     class Append < Base
       attr_accessor :cas # @return [Integer]
@@ -1849,6 +1994,7 @@ module Couchbase
       attr_accessor :profile # @return [Symbol]
       attr_accessor :flex_index # @return [Boolean]
       attr_accessor :preserve_expiry # @return [Boolean]
+      attr_accessor :use_replica # @return [Boolean, nil]
       attr_accessor :scope_qualifier # @return [String]
       attr_accessor :transcoder # @return [JsonTranscoder, #decode(String)]
 
@@ -1894,6 +2040,8 @@ module Couchbase
       # @param [Boolean, nil] flex_index Tells the query engine to use a flex index (utilizing the search service)
       # @param [Boolean, nil] preserve_expiry Tells the query engine to preserve expiration values set on any documents
       #   modified by this query.
+      # @param [Boolean, nil] use_replica Specifies that the query engine should use replica nodes for KV fetches if
+      #   the active node is down. If not provided, the server default will be used
       # @param [String, nil] scope_qualifier Associate scope qualifier (also known as +query_context+) with the query.
       #   The qualifier must be in form +{bucket_name}.{scope_name}+ or +default:{bucket_name}.{scope_name}+.
       # @param [JsonTranscoder] transcoder to decode rows
@@ -1925,6 +2073,7 @@ module Couchbase
                      profile: :off,
                      flex_index: nil,
                      preserve_expiry: nil,
+                     use_replica: nil,
                      scope_qualifier: nil,
                      scan_consistency: :not_bounded,
                      mutation_state: nil,
@@ -1950,6 +2099,7 @@ module Couchbase
         @profile = profile
         @flex_index = flex_index
         @preserve_expiry = preserve_expiry
+        @use_replica = use_replica
         @scope_qualifier = scope_qualifier
         @scan_consistency = scan_consistency
         @mutation_state = mutation_state
@@ -2043,6 +2193,7 @@ module Couchbase
           readonly: @readonly,
           flex_index: @flex_index,
           preserve_expiry: @preserve_expiry,
+          use_replica: @use_replica,
           scan_wait: Utils::Time.extract_duration(@scan_wait),
           scan_cap: @scan_cap,
           pipeline_batch: @pipeline_batch,

data/lib/couchbase/scope.rb

@@ -79,7 +79,7 @@ module Couchbase
               metrics.warning_count = resp[:meta][:metrics][:warning_count]
             end
           end
-          res[:warnings] = resp[:warnings].map { |warn| Cluster::QueryWarning.new(warn[:code], warn[:message]) } if resp[:warnings]
+          meta.warnings = resp[:warnings].map { |warn| Cluster::QueryWarning.new(warn[:code], warn[:message]) } if resp[:warnings]
         end
         res.instance_variable_set(:@rows, resp[:rows])
       end

data/lib/couchbase/utils/time.rb

@@ -48,8 +48,21 @@ module Couchbase
         end
       end
 
+      # This method converts its argument to milliseconds
+      #
+      # 1. Integer values are interpreted as a number of milliseconds
+      # 2. If the argument is a Duration-like object and responds to #in_milliseconds,
+      #    then use it and convert result to Integer
+      # 3. Otherwise invoke #to_i on the argument and interpret it as a number of milliseconds
       def extract_duration(number_or_duration)
-        number_or_duration.respond_to?(:in_milliseconds) ? number_or_duration.public_send(:in_milliseconds) : number_or_duration
+        return unless number_or_duration
+        return number_or_duration if number_or_duration.class == Integer # rubocop:disable Style/ClassEqualityComparison avoid overrides of #is_a?, #kind_of?
+
+        if number_or_duration.respond_to?(:in_milliseconds)
+          number_or_duration.public_send(:in_milliseconds)
+        else
+          number_or_duration
+        end.to_i
       end
     end
   end

data/lib/couchbase/version.rb

@@ -19,5 +19,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.4.3".freeze)
+  VERSION.update(:sdk => "3.4.5".freeze)
 end