couchbase 3.0.2 → 3.0.3

data/lib/couchbase/management.rb

@@ -0,0 +1,27 @@
+#    Copyright 2020 Couchbase, Inc.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+module Couchbase
+  # This namespace includes manager classes to control cluster resources and perform maintenance operations.
+  module Management
+  end
+end
+
+require "couchbase/management/analytics_index_manager"
+require "couchbase/management/bucket_manager"
+require "couchbase/management/collection_manager"
+require "couchbase/management/query_index_manager"
+require "couchbase/management/search_index_manager"
+require "couchbase/management/user_manager"
+require "couchbase/management/view_index_manager"

data/lib/couchbase/management/bucket_manager.rb

@@ -48,6 +48,7 @@ module Couchbase
             ejection_policy: settings.ejection_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,
           }, options.timeout
         )
@@ -74,6 +75,7 @@ module Couchbase
             ejection_policy: settings.ejection_policy,
             max_expiry: settings.max_expiry,
             compression_mode: settings.compression_mode,
+            minimum_durability_level: settings.minimum_durability_level,
           }, options.timeout
         )
       end
@@ -111,7 +113,7 @@ module Couchbase
       # @return [Array<BucketSettings>]
       def get_all_buckets(options = GetAllBucketsOptions.new)
         res = @backend.bucket_get_all(options.timeout)
-        res.map(&method(:extract_bucket_settings))
+        res.map { |entry| extract_bucket_settings(entry) }
       end
 
       # @param [String] bucket_name name of the bucket
@@ -190,7 +192,8 @@ module Couchbase
           bucket.replica_indexes = entry[:replica_indexes]
           bucket.bucket_type = entry[:bucket_type]
           bucket.max_expiry = entry[:max_expiry]
-          bucket.ejection_policy = entry[:max_expiry]
+          bucket.eviction_policy = entry[:eviction_policy]
+          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" })
         end
@@ -247,6 +250,9 @@ module Couchbase
       # @return [:timestamp, :sequence_number] conflict resolution policy
       attr_accessor :conflict_resolution_type
 
+      # @return [nil, :none, :majority, :majority_and_persist_to_active, :persist_to_majority] the minimum durability level
+      attr_accessor :minimum_durability_level
+
       # @api private
       # @return [Boolean] false if status of the bucket is not healthy
       def healthy?
@@ -269,6 +275,7 @@ module Couchbase
       def initialize
         @bucket_type = :couchbase
         @name = nil
+        @minimum_durability_level = nil
         @healthy = true
         @flush_enabled = false
         @ram_quota_mb = 100

data/lib/couchbase/management/collection_manager.rb

@@ -46,7 +46,7 @@ module Couchbase
         end
       end
 
-      # Removes a scope
+      # Get a scope by name
       #
       # @param [String] scope_name name of the scope
       # @param [GetScopeOptions] options

data/lib/couchbase/management/user_manager.rb

@@ -45,7 +45,7 @@ module Couchbase
       # @return [Array<UserAndMetadata>]
       def get_all_users(options = GetAllUsersOptions.new)
         resp = @backend.user_get_all(options.domain, options.timeout)
-        resp.map(&method(:extract_user))
+        resp.map { |entry| extract_user(entry) }
       end
 
       # Creates or updates a user
@@ -121,7 +121,7 @@ module Couchbase
       # @return [Array<Group>]
       def get_all_groups(options = GetAllGroupsOptions.new)
         resp = @backend.group_get_all(options.timeout)
-        resp.map(&method(:extract_group))
+        resp.map { |entry| extract_group(entry) }
       end
 
       # Creates or updates a group
@@ -164,6 +164,7 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @yieldparam [GetUserOptions] self
         def initialize
           @domain = :local
           yield self if block_given?
@@ -177,6 +178,7 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @yieldparam [GetAllUsersOptions] self
         def initialize
           @domain = :local
           yield self if block_given?
@@ -190,6 +192,7 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @yieldparam [UpsertUserOptions] self
         def initialize
           @domain = :local
           yield self if block_given?
@@ -203,6 +206,7 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @yieldparam [DropUserOptions] self
         def initialize
           @domain = :local
           yield self if block_given?
@@ -213,6 +217,7 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @yieldparam [GetRolesOptions] self
         def initialize
           yield self if block_given?
         end
@@ -222,6 +227,7 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @yieldparam [GetGroupOptions] self
         def initialize
           yield self if block_given?
         end
@@ -231,6 +237,7 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @yieldparam [GetAllGroupsOptions] self
         def initialize
           yield self if block_given?
         end
@@ -240,6 +247,7 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @yieldparam [UpsertGroupOptions] self
         def initialize
           yield self if block_given?
         end
@@ -249,6 +257,7 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @yieldparam [DropGroupOptions] self
         def initialize
           yield self if block_given?
         end
@@ -327,6 +336,7 @@ module Couchbase
       # @return [String]
       attr_accessor :collection
 
+      # @yieldparam [Role] self
       def initialize
         yield self if block_given?
       end
@@ -339,6 +349,7 @@ module Couchbase
       # @return [String]
       attr_accessor :description
 
+      # @yieldparam [RoleAndDescription] self
       def initialize
         super
         yield self if block_given?
@@ -352,6 +363,7 @@ module Couchbase
       # @return [String]
       attr_writer :name
 
+      # @yieldparam [Origin] self
       def initialize
         yield self if block_given?
       end
@@ -361,6 +373,7 @@ module Couchbase
       # @return [Array<Origin>]
       attr_writer :origins
 
+      # @yieldparam [RoleAndOrigins] self
       def initialize
         super
         @origins = []
@@ -384,6 +397,7 @@ module Couchbase
       # @return [String]
       attr_accessor :password
 
+      # @yieldparam [User] self
       def initialize
         @groups = []
         @roles = []
@@ -404,6 +418,7 @@ module Couchbase
       # @return [Array<String>]
       attr_accessor :external_groups
 
+      # @yieldparam [UserAndMetadata] self
       def initialize
         super
         @effective_roles = []
@@ -424,6 +439,7 @@ module Couchbase
       # @return [String]
       attr_accessor :ldap_group_reference
 
+      # @yieldparam [Group] self
       def initialize
         @roles = []
         yield self if block_given?

data/lib/couchbase/options.rb

@@ -1,4 +1,4 @@
-#    Copyright 2020 Couchbase, Inc.
+#    Copyright 2020-2021 Couchbase, Inc.
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -12,6 +12,8 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
+require "couchbase/utils/time"
+
 module Couchbase
   # Definition of the Option classes for data APIs
   module Options # rubocop:disable Metrics/ModuleLength
@@ -454,7 +456,7 @@ module Couchbase
 
       # Creates an instance of options for {Collection#insert}
       #
-      # @param [Integer, #in_seconds, nil] expiry expiration time to associate with the document
+      # @param [Integer, #in_seconds, Time, nil] expiry expiration time to associate with the document
       # @param [JsonTranscoder, #encode(Object)] transcoder used for encoding
       # @param [Symbol] durability_level level of durability
       #  +:none+::
@@ -484,7 +486,7 @@ module Couchbase
                      client_context: nil,
                      parent_span: nil)
         super(timeout: timeout, retry_strategy: retry_strategy, client_context: client_context, parent_span: parent_span)
-        @expiry = expiry
+        @expiry = Utils::Time.extract_expiry_time(expiry)
         @transcoder = transcoder
         @durability_level = durability_level
         yield self if block_given?
@@ -494,7 +496,7 @@ module Couchbase
       def to_backend
         {
           timeout: @timeout.respond_to?(:in_milliseconds) ? @timeout.public_send(:in_milliseconds) : @timeout,
-          expiry: @expiry.respond_to?(:in_seconds) ? @expiry.public_send(:in_seconds) : @expiry,
+          expiry: @expiry,
           durability_level: @durability_level,
         }
       end
@@ -508,7 +510,7 @@ module Couchbase
 
       # Creates an instance of options for {Collection#upsert}
       #
-      # @param [Integer, #in_seconds, nil] expiry expiration time to associate with the document
+      # @param [Integer, #in_seconds, Time, nil] expiry expiration time to associate with the document
       # @param [JsonTranscoder, #encode(Object)] transcoder used for encoding
       # @param [Symbol] durability_level level of durability
       #  +:none+::
@@ -538,7 +540,7 @@ module Couchbase
                      client_context: nil,
                      parent_span: nil)
         super(timeout: timeout, retry_strategy: retry_strategy, client_context: client_context, parent_span: parent_span)
-        @expiry = expiry
+        @expiry = Utils::Time.extract_expiry_time(expiry)
         @transcoder = transcoder
         @durability_level = durability_level
         yield self if block_given?
@@ -547,7 +549,7 @@ module Couchbase
       def to_backend
         {
           timeout: @timeout.respond_to?(:in_milliseconds) ? @timeout.public_send(:in_milliseconds) : @timeout,
-          expiry: @expiry.respond_to?(:in_seconds) ? @expiry.public_send(:in_seconds) : @expiry,
+          expiry: @expiry,
           durability_level: @durability_level,
         }
       end
@@ -561,7 +563,7 @@ module Couchbase
 
       # Creates an instance of options for {Collection#upsert}
       #
-      # @param [Integer, #in_seconds, nil] expiry expiration time to associate with the document
+      # @param [Integer, #in_seconds, Time, nil] expiry expiration time to associate with the document
       # @param [JsonTranscoder, #encode(Object)] transcoder used for encoding
       # @param [Symbol] durability_level level of durability
       #  +:none+::
@@ -591,7 +593,7 @@ module Couchbase
                      client_context: nil,
                      parent_span: nil)
         super(timeout: timeout, retry_strategy: retry_strategy, client_context: client_context, parent_span: parent_span)
-        @expiry = expiry
+        @expiry = Utils::Time.extract_expiry_time(expiry)
         @transcoder = transcoder
         @durability_level = durability_level
         yield self if block_given?
@@ -600,7 +602,7 @@ module Couchbase
       def to_backend
         {
           timeout: @timeout.respond_to?(:in_milliseconds) ? @timeout.public_send(:in_milliseconds) : @timeout,
-          expiry: @expiry.respond_to?(:in_seconds) ? @expiry.public_send(:in_seconds) : @expiry,
+          expiry: @expiry,
           durability_level: @durability_level,
         }
       end
@@ -647,7 +649,7 @@ module Couchbase
                      client_context: nil,
                      parent_span: nil)
         super(timeout: timeout, retry_strategy: retry_strategy, client_context: client_context, parent_span: parent_span)
-        @expiry = expiry
+        @expiry = Utils::Time.extract_expiry_time(expiry)
         @transcoder = transcoder
         @cas = cas
         @durability_level = durability_level
@@ -657,7 +659,7 @@ module Couchbase
       def to_backend
         {
           timeout: @timeout.respond_to?(:in_milliseconds) ? @timeout.public_send(:in_milliseconds) : @timeout,
-          expiry: @expiry.respond_to?(:in_seconds) ? @expiry.public_send(:in_seconds) : @expiry,
+          expiry: @expiry,
           durability_level: @durability_level,
           cas: @cas,
         }
@@ -676,7 +678,7 @@ module Couchbase
 
       # Creates an instance of options for {Collection#mutate_in}
       #
-      # @param [Integer, #in_seconds, nil] expiry expiration time to associate with the document
+      # @param [Integer, #in_seconds, Time, nil] expiry expiration time to associate with the document
       # @param [Symbol] store_semantics describes how the outer document store semantics on subdoc should act
       #  +:replace+:: replace the document, fail if it does not exist. This is the default
       #  +:upsert+:: replace the document or create if it does not exist
@@ -717,7 +719,7 @@ module Couchbase
                      client_context: nil,
                      parent_span: nil)
         super(timeout: timeout, retry_strategy: retry_strategy, client_context: client_context, parent_span: parent_span)
-        @expiry = expiry
+        @expiry = Utils::Time.extract_expiry_time(expiry)
         @store_semantics = store_semantics
         @cas = cas
         @access_deleted = access_deleted
@@ -731,7 +733,7 @@ module Couchbase
       def to_backend
         {
           timeout: @timeout.respond_to?(:in_milliseconds) ? @timeout.public_send(:in_milliseconds) : @timeout,
-          expiry: @expiry.respond_to?(:in_seconds) ? @expiry.public_send(:in_seconds) : @expiry,
+          expiry: @expiry,
           durability_level: @durability_level,
           cas: @cas,
           store_semantics: @store_semantics,
@@ -856,7 +858,7 @@ module Couchbase
       #
       # @param [Integer] delta the delta for the operation
       # @param [Integer] initial if present, holds the initial value
-      # @param [Integer, #in_seconds] expiry if set, holds the expiration for the operation
+      # @param [Integer, #in_seconds, Time, nil] expiry if set, holds the expiration for the operation
       # @param [Symbol] durability_level level of durability
       #  +:none+::
       #     no enhanced durability required for the mutation
@@ -890,7 +892,7 @@ module Couchbase
         super(timeout: timeout, retry_strategy: retry_strategy, client_context: client_context, parent_span: parent_span)
         @delta = delta
         @initial = initial
-        @expiry = expiry
+        @expiry = Utils::Time.extract_expiry_time(expiry)
         @durability_level = durability_level
         yield self if block_given?
       end
@@ -908,7 +910,7 @@ module Couchbase
           timeout: @timeout.respond_to?(:in_milliseconds) ? @timeout.public_send(:in_milliseconds) : @timeout,
           delta: @delta,
           initial_value: @initial,
-          expiry: @expiry.respond_to?(:in_seconds) ? @expiry.public_send(:in_seconds) : @expiry,
+          expiry: @expiry,
           durability_level: @durability_level,
         }
       end
@@ -925,7 +927,7 @@ module Couchbase
       #
       # @param [Integer] delta the delta for the operation
       # @param [Integer] initial if present, holds the initial value
-      # @param [Integer, #in_seconds] expiry if set, holds the expiration for the operation
+      # @param [Integer, #in_seconds, Time, nil] expiry if set, holds the expiration for the operation
       # @param [Symbol] durability_level level of durability
       #  +:none+::
       #     no enhanced durability required for the mutation
@@ -959,7 +961,7 @@ module Couchbase
         super(timeout: timeout, retry_strategy: retry_strategy, client_context: client_context, parent_span: parent_span)
         @delta = delta
         @initial = initial
-        @expiry = expiry
+        @expiry = Utils::Time.extract_expiry_time(expiry)
         @durability_level = durability_level
         yield self if block_given?
       end
@@ -977,7 +979,7 @@ module Couchbase
           timeout: @timeout.respond_to?(:in_milliseconds) ? @timeout.public_send(:in_milliseconds) : @timeout,
           delta: @delta,
           initial_value: @initial,
-          expiry: @expiry.respond_to?(:in_seconds) ? @expiry.public_send(:in_seconds) : @expiry,
+          expiry: @expiry,
           durability_level: @durability_level,
         }
       end
@@ -1166,6 +1168,7 @@ module Couchbase
       attr_accessor :readonly # @return [Boolean]
       attr_accessor :priority # @return [Boolean]
       attr_accessor :transcoder # @return [JsonTranscoder, #decode(String)]
+      attr_accessor :scope_qualifier # @return [String]
 
       # Creates new instance of options for {Couchbase::Cluster#analytics_query}
       #
@@ -1191,6 +1194,8 @@ module Couchbase
       #   like +$1+, +$2+ in query string
       # @param [Hash<String => #to_json>, nil] named_parameters parameters to be used as substitution for named macros
       #   like +$name+ in query string
+      # @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 [Integer, #in_milliseconds, nil] timeout
       # @param [Proc, nil] retry_strategy the custom retry strategy, if set
@@ -1207,6 +1212,7 @@ module Couchbase
                      transcoder: JsonTranscoder.new,
                      positional_parameters: nil,
                      named_parameters: nil,
+                     scope_qualifier: nil,
                      timeout: nil,
                      retry_strategy: nil,
                      client_context: nil,
@@ -1221,6 +1227,7 @@ module Couchbase
         @transcoder = transcoder
         @positional_parameters = positional_parameters
         @named_parameters = named_parameters
+        @scope_qualifier = scope_qualifier
         @raw_parameters = {}
         yield self if block_given?
       end
@@ -1250,7 +1257,7 @@ module Couchbase
       end
 
       # @api private
-      def to_backend
+      def to_backend(scope_name: nil, bucket_name: nil)
         {
           timeout: @timeout.respond_to?(:in_milliseconds) ? @timeout.public_send(:in_milliseconds) : @timeout,
           client_context_id: @client_context_id,
@@ -1260,6 +1267,9 @@ module Couchbase
           positional_parameters: export_positional_parameters,
           named_parameters: export_named_parameters,
           raw_parameters: @raw_parameters,
+          scope_qualifier: @scope_qualifier,
+          scope_name: scope_name,
+          bucket_name: bucket_name,
         }
       end
 
@@ -1337,7 +1347,7 @@ module Couchbase
       #   +:request_plus+::
       #     The indexer will wait until all mutations have been processed at the time of request before returning to
       #     the query engine.
-      # @return [Boolean, nil] flex_index Tells the query engine to use a flex index (utilizing the search service)
+      # @param [Boolean, nil] flex_index Tells the query engine to use a flex index (utilizing the search service)
       # @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