couchbase 3.4.4 → 3.4.5

data/lib/couchbase/management/bucket_manager.rb

@@ -211,12 +211,15 @@ module Couchbase
             num_replicas: settings.num_replicas,
             replica_indexes: settings.replica_indexes,
             bucket_type: settings.bucket_type,
-            ejection_policy: settings.ejection_policy,
+            eviction_policy: settings.eviction_policy,
             max_expiry: settings.max_expiry,
             compression_mode: settings.compression_mode,
             minimum_durability_level: settings.minimum_durability_level,
             conflict_resolution_type: settings.conflict_resolution_type,
             storage_backend: settings.storage_backend,
+            history_retention_collection_default: settings.history_retention_collection_default,
+            history_retention_duration: settings.history_retention_duration,
+            history_retention_bytes: settings.history_retention_bytes,
           }, options.to_backend
         )
       end
@@ -239,11 +242,14 @@ module Couchbase
             num_replicas: settings.num_replicas,
             replica_indexes: settings.replica_indexes,
             bucket_type: settings.bucket_type,
-            ejection_policy: settings.ejection_policy,
+            eviction_policy: settings.eviction_policy,
             max_expiry: settings.max_expiry,
             compression_mode: settings.compression_mode,
             minimum_durability_level: settings.minimum_durability_level,
             storage_backend: settings.storage_backend,
+            history_retention_collection_default: settings.history_retention_collection_default,
+            history_retention_bytes: settings.history_retention_bytes,
+            history_retention_duration: settings.history_retention_duration,
           }, options.to_backend
         )
       end
@@ -334,6 +340,9 @@ module Couchbase
           bucket.minimum_durability_level = entry[:minimum_durability_level]
           bucket.compression_mode = entry[:compression_mode]
           bucket.instance_variable_set(:@healthy, entry[:nodes].all? { |node| node[:status] == "healthy" })
+          bucket.history_retention_collection_default = entry[:history_retention_collection_default]
+          bucket.history_retention_bytes = entry[:history_retention_bytes]
+          bucket.history_retention_duration = entry[:history_retention_duration]
         end
       end
     end
@@ -394,6 +403,17 @@ module Couchbase
       # @return [nil, :none, :majority, :majority_and_persist_to_active, :persist_to_majority] the minimum durability level
       attr_accessor :minimum_durability_level
 
+      # @return [Boolean, nil] whether to enable history retention on collections  by default
+      attr_accessor :history_retention_collection_default
+
+      # @return [Integer, nil] the maximum size, in bytes, of the change history that is written to disk for all
+      # collections in this bucket
+      attr_accessor :history_retention_bytes
+
+      # @return [Integer, nil] the maximum duration, in seconds, to be covered by the change history that is written to disk for all
+      # collections in this bucket
+      attr_accessor :history_retention_duration
+
       # @api private
       # @return [Boolean] false if status of the bucket is not healthy
       def healthy?
@@ -416,19 +436,6 @@ module Couchbase
 
       # @yieldparam [BucketSettings] self
       def initialize
-        @bucket_type = :couchbase
-        @name = nil
-        @minimum_durability_level = nil
-        @healthy = true
-        @flush_enabled = false
-        @ram_quota_mb = 100
-        @num_replicas = 1
-        @replica_indexes = false
-        @max_expiry = 0
-        @compression_mode = :passive
-        @conflict_resolution_type = :sequence_number
-        @eviction_policy = :value_only
-        @storage_backend = nil
         yield self if block_given?
       end
     end

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/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.4".freeze)
+  VERSION.update(:sdk => "3.4.5".freeze)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: couchbase
 version: !ruby/object:Gem::Version
-  version: 3.4.4
+  version: 3.4.5
 platform: ruby
 authors:
 - Sergey Avseyev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-08-21 00:00:00.000000000 Z
+date: 2023-10-10 00:00:00.000000000 Z
 dependencies: []
 description: Modern SDK for Couchbase Server
 email:
@@ -118,7 +118,9 @@ files:
 - ext/couchbase/core/impl/configuration_profiles_registry.cxx
 - ext/couchbase/core/impl/conjunction_query.cxx
 - ext/couchbase/core/impl/create_bucket.cxx
+- ext/couchbase/core/impl/create_collection.cxx
 - ext/couchbase/core/impl/create_query_index.cxx
+- ext/couchbase/core/impl/create_scope.cxx
 - ext/couchbase/core/impl/date_range.cxx
 - ext/couchbase/core/impl/date_range_facet.cxx
 - ext/couchbase/core/impl/date_range_facet_result.cxx
@@ -128,7 +130,9 @@ files:
 - ext/couchbase/core/impl/dns_srv_tracker.cxx
 - ext/couchbase/core/impl/dns_srv_tracker.hxx
 - ext/couchbase/core/impl/drop_bucket.cxx
+- ext/couchbase/core/impl/drop_collection.cxx
 - ext/couchbase/core/impl/drop_query_index.cxx
+- ext/couchbase/core/impl/drop_scope.cxx
 - ext/couchbase/core/impl/encoded_search_facet.hxx
 - ext/couchbase/core/impl/encoded_search_query.hxx
 - ext/couchbase/core/impl/encoded_search_sort.hxx
@@ -145,6 +149,7 @@ files:
 - ext/couchbase/core/impl/get_all_query_indexes.cxx
 - ext/couchbase/core/impl/get_all_replicas.cxx
 - ext/couchbase/core/impl/get_all_replicas.hxx
+- ext/couchbase/core/impl/get_all_scopes.cxx
 - ext/couchbase/core/impl/get_and_lock.cxx
 - ext/couchbase/core/impl/get_and_touch.cxx
 - ext/couchbase/core/impl/get_any_replica.cxx
@@ -254,6 +259,7 @@ files:
 - ext/couchbase/core/impl/transaction_op_error_category.cxx
 - ext/couchbase/core/impl/unlock.cxx
 - ext/couchbase/core/impl/update_bucket.cxx
+- ext/couchbase/core/impl/update_collection.cxx
 - ext/couchbase/core/impl/upsert.cxx
 - ext/couchbase/core/impl/view_error_category.cxx
 - ext/couchbase/core/impl/watch_query_indexes.cxx
@@ -478,6 +484,8 @@ files:
 - ext/couchbase/core/operations/management/collection_create.hxx
 - ext/couchbase/core/operations/management/collection_drop.cxx
 - ext/couchbase/core/operations/management/collection_drop.hxx
+- ext/couchbase/core/operations/management/collection_update.cxx
+- ext/couchbase/core/operations/management/collection_update.hxx
 - ext/couchbase/core/operations/management/collections.hxx
 - ext/couchbase/core/operations/management/collections_manifest_get.cxx
 - ext/couchbase/core/operations/management/collections_manifest_get.hxx
@@ -851,6 +859,7 @@ files:
 - ext/couchbase/couchbase/codec/tao_json_serializer.hxx
 - ext/couchbase/couchbase/codec/transcoder_traits.hxx
 - ext/couchbase/couchbase/collection.hxx
+- ext/couchbase/couchbase/collection_manager.hxx
 - ext/couchbase/couchbase/collection_query_index_manager.hxx
 - ext/couchbase/couchbase/common_durability_options.hxx
 - ext/couchbase/couchbase/common_options.hxx
@@ -860,8 +869,10 @@ files:
 - ext/couchbase/couchbase/conjunction_query.hxx
 - ext/couchbase/couchbase/counter_result.hxx
 - ext/couchbase/couchbase/create_bucket_options.hxx
+- ext/couchbase/couchbase/create_collection_options.hxx
 - ext/couchbase/couchbase/create_primary_query_index_options.hxx
 - ext/couchbase/couchbase/create_query_index_options.hxx
+- ext/couchbase/couchbase/create_scope_options.hxx
 - ext/couchbase/couchbase/date_range.hxx
 - ext/couchbase/couchbase/date_range_facet.hxx
 - ext/couchbase/couchbase/date_range_facet_result.hxx
@@ -871,8 +882,10 @@ files:
 - ext/couchbase/couchbase/dns_options.hxx
 - ext/couchbase/couchbase/doc_id_query.hxx
 - ext/couchbase/couchbase/drop_bucket_options.hxx
+- ext/couchbase/couchbase/drop_collection_options.hxx
 - ext/couchbase/couchbase/drop_primary_query_index_options.hxx
 - ext/couchbase/couchbase/drop_query_index_options.hxx
+- ext/couchbase/couchbase/drop_scope_options.hxx
 - ext/couchbase/couchbase/durability_level.hxx
 - ext/couchbase/couchbase/error_codes.hxx
 - ext/couchbase/couchbase/error_context.hxx
@@ -901,6 +914,7 @@ files:
 - ext/couchbase/couchbase/get_all_buckets_options.hxx
 - ext/couchbase/couchbase/get_all_query_indexes_options.hxx
 - ext/couchbase/couchbase/get_all_replicas_options.hxx
+- ext/couchbase/couchbase/get_all_scopes_options.hxx
 - ext/couchbase/couchbase/get_and_lock_options.hxx
 - ext/couchbase/couchbase/get_and_touch_options.hxx
 - ext/couchbase/couchbase/get_any_replica_options.hxx
@@ -924,7 +938,9 @@ files:
 - ext/couchbase/couchbase/lookup_in_result.hxx
 - ext/couchbase/couchbase/lookup_in_specs.hxx
 - ext/couchbase/couchbase/management/bucket_settings.hxx
+- ext/couchbase/couchbase/management/collection_spec.hxx
 - ext/couchbase/couchbase/management/query_index.hxx
+- ext/couchbase/couchbase/management/scope_spec.hxx
 - ext/couchbase/couchbase/manager_error_context.hxx
 - ext/couchbase/couchbase/match_all_query.hxx
 - ext/couchbase/couchbase/match_none_query.hxx
@@ -1039,6 +1055,7 @@ files:
 - ext/couchbase/couchbase/transactions/transactions_query_config.hxx
 - ext/couchbase/couchbase/unlock_options.hxx
 - ext/couchbase/couchbase/update_bucket_options.hxx
+- ext/couchbase/couchbase/update_collection_options.hxx
 - ext/couchbase/couchbase/upsert_options.hxx
 - ext/couchbase/couchbase/wan_development_configuration_profile.hxx
 - ext/couchbase/couchbase/watch_query_indexes_options.hxx
@@ -2428,9 +2445,9 @@ metadata:
   homepage_uri: https://docs.couchbase.com/ruby-sdk/current/hello-world/start-using-sdk.html
   bug_tracker_uri: https://couchbase.com/issues/browse/RCBC
   mailing_list_uri: https://forums.couchbase.com/c/ruby-sdk
-  source_code_uri: https://github.com/couchbase/couchbase-ruby-client/tree/3.4.4
-  changelog_uri: https://github.com/couchbase/couchbase-ruby-client/releases/tag/3.4.4
-  documentation_uri: https://docs.couchbase.com/sdk-api/couchbase-ruby-client-3.4.4/index.html
+  source_code_uri: https://github.com/couchbase/couchbase-ruby-client/tree/3.4.5
+  changelog_uri: https://github.com/couchbase/couchbase-ruby-client/releases/tag/3.4.5
+  documentation_uri: https://docs.couchbase.com/sdk-api/couchbase-ruby-client-3.4.5/index.html
   github_repo: ssh://github.com/couchbase/couchbase-ruby-client
   rubygems_mfa_required: 'true'
 post_install_message: 
@@ -2443,7 +2460,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="