couchbase 3.0.0.alpha.5 → 3.0.3

data/lib/couchbase/json_transcoder.rb

@@ -23,10 +23,10 @@ module Couchbase
     end
 
     # @param [String, nil] blob string of bytes, containing encoded representation of the document
-    # @param [Integer, :json] flags bit field, describing how the data encoded
+    # @param [Integer, :json] _flags bit field, describing how the data encoded
     # @return Object decoded document
-    def decode(blob, flags)
-      JSON.parse(blob) unless blob.nil?
+    def decode(blob, _flags)
+      JSON.parse(blob) unless blob&.empty?
     end
   end
 end

data/{bin/check-cluster → lib/couchbase/logger.rb}

@@ -1,5 +1,3 @@
-#!/usr/bin/env bash
-
 #    Copyright 2020 Couchbase, Inc.
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
@@ -14,18 +12,31 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-HOST=${HOST:-localhost}
-USERNAME=${USERNAME:-Administrator}
-PASSWORD=${PASSWOWRD:-password}
-
-CREDS="${USERNAME}:${PASSWORD}"
-
-sleep 1
-
-set -ex
-
-curl -sS -w "\n" -u${CREDS} http://${HOST}:8091/pools
-curl -sS -w "\n" -u${CREDS} http://${HOST}:8091/pools/default
-curl -sS -w "\n" -u${CREDS} http://${HOST}:8091/pools/default/buckets/default
-curl -sS -w "\n" -u${CREDS} http://${HOST}:8091/pools/default/b/default
+module Couchbase
+  # Set log level
+  #
+  # @note The level might be also be set with environment variable +COUCHBASE_BACKEND_LOG_LEVEL+
+  #
+  # @param [Symbol] level new log level.
+  #
+  #   Allowed levels (in order of decreasing verbosity):
+  #   * +:trace+
+  #   * +:debug+
+  #   * +:info+ (default)
+  #   * +:warn+
+  #   * +:error+
+  #   * +:critical+
+  #   * +:off+
+  #
+  # @return [void]
+  def self.log_level=(level)
+    Backend.set_log_level(level)
+  end
 
+  # Get current log level
+  #
+  # @return [Symbol] current log level
+  def self.log_level
+    Backend.get_log_level
+  end
+end

data/lib/couchbase/{common_options.rb → management.rb}

@@ -13,17 +13,15 @@
 #  limitations under the License.
 
 module Couchbase
-  class CommonOptions
-    # @return [Integer] the time in milliseconds allowed for the operation to complete
-    attr_accessor :timeout
-
-    # @return [Proc] the custom retry strategy, if set
-    attr_accessor :retry_strategy
-
-    # @return [Hash] the client context data, if set
-    attr_accessor :client_context
-
-    # @return [Span] If set holds the parent span, that should be used for this request
-    attr_accessor :parent_span
+  # This namespace includes manager classes to control cluster resources and perform maintenance operations.
+  module Management
   end
-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/analytics_index_manager.rb

@@ -17,7 +17,7 @@ require "couchbase/errors"
 module Couchbase
   module Management
     class AnalyticsIndexManager
-      alias_method :inspect, :to_s
+      alias inspect to_s
 
       # @param [Couchbase::Backend] backend
       def initialize(backend)
@@ -35,9 +35,9 @@ module Couchbase
       # @raise [Error::DataverseExists]
       def create_dataverse(dataverse_name, options = CreateDataverseOptions.new)
         @backend.analytics_dataverse_create(
-            dataverse_name,
-            options.ignore_if_exists,
-            options.timeout
+          dataverse_name,
+          options.ignore_if_exists,
+          options.timeout
         )
       end
 
@@ -52,9 +52,9 @@ module Couchbase
       # @raise [Error::DataverseNotFound]
       def drop_dataverse(dataverse_name, options = DropDataverseOptions.new)
         @backend.analytics_dataverse_drop(
-            dataverse_name,
-            options.ignore_if_does_not_exist,
-            options.timeout
+          dataverse_name,
+          options.ignore_if_does_not_exist,
+          options.timeout
         )
       end
 
@@ -71,12 +71,12 @@ module Couchbase
       # @raise [Error::LinkNotFound]
       def create_dataset(dataset_name, bucket_name, options = CreateDatasetOptions.new)
         @backend.analytics_dataset_create(
-            dataset_name,
-            bucket_name,
-            options.condition,
-            options.dataverse_name,
-            options.ignore_if_exists,
-            options.timeout
+          dataset_name,
+          bucket_name,
+          options.condition,
+          options.dataverse_name,
+          options.ignore_if_exists,
+          options.timeout
         )
       end
 
@@ -91,10 +91,10 @@ module Couchbase
       # @raise [Error::DatasetNotFound]
       def drop_dataset(dataset_name, options = DropDatasetOptions.new)
         @backend.analytics_dataset_drop(
-            dataset_name,
-            options.dataverse_name,
-            options.ignore_if_does_not_exist,
-            options.timeout
+          dataset_name,
+          options.dataverse_name,
+          options.ignore_if_does_not_exist,
+          options.timeout
         )
       end
 
@@ -128,12 +128,12 @@ module Couchbase
       # @raise [Error::IndexExists]
       def create_index(index_name, dataset_name, fields, options = CreateIndexOptions.new)
         @backend.analytics_index_create(
-            index_name,
-            dataset_name,
-            fields.entries,
-            options.dataverse_name,
-            options.ignore_if_exists,
-            options.timeout
+          index_name,
+          dataset_name,
+          fields.entries,
+          options.dataverse_name,
+          options.ignore_if_exists,
+          options.timeout
         )
       end
 
@@ -149,11 +149,11 @@ module Couchbase
       # @raise [Error::IndexNotFound]
       def drop_index(index_name, dataset_name, options = DropIndexOptions.new)
         @backend.analytics_index_drop(
-            index_name,
-            dataset_name,
-            options.dataverse_name,
-            options.ignore_if_does_not_exist,
-            options.timeout
+          index_name,
+          dataset_name,
+          options.dataverse_name,
+          options.ignore_if_does_not_exist,
+          options.timeout
         )
       end
 
@@ -184,10 +184,10 @@ module Couchbase
       # @raise [Error::LinkNotFound]
       def connect_link(options = ConnectLinkOptions.new)
         @backend.analytics_link_connect(
-            options.link_name,
-            options.force,
-            options.dataverse_name,
-            options.timeout
+          options.link_name,
+          options.force,
+          options.dataverse_name,
+          options.timeout
         )
       end
 
@@ -201,9 +201,9 @@ module Couchbase
       # @raise [Error::LinkNotFound]
       def disconnect_link(options = DisconnectLinkOptions.new)
         @backend.analytics_link_disconnect(
-            options.link_name,
-            options.dataverse_name,
-            options.timeout
+          options.link_name,
+          options.dataverse_name,
+          options.timeout
         )
       end
 
@@ -218,7 +218,7 @@ module Couchbase
       #   and values are number of mutations for given dataset.
       def get_pending_mutations(options = GetPendingMutationsOptions.new)
         @backend.analytics_get_pending_mutations(
-            options.timeout
+          options.timeout
         )
       end
 
@@ -422,7 +422,7 @@ module Couchbase
 
       # @return [Boolean]
       attr_accessor :is_primary
-      alias_method :primary?, :is_primary
+      alias primary? is_primary
 
       # @yieldparam [AnalyticsIndex]
       def initialize

data/lib/couchbase/management/bucket_manager.rb

@@ -14,10 +14,12 @@
 
 require "couchbase/errors"
 
+require "rubygems/deprecate"
+
 module Couchbase
   module Management
     class BucketManager
-      alias_method :inspect, :to_s
+      alias inspect to_s
 
       # @param [Couchbase::Backend] backend
       def initialize(backend)
@@ -35,19 +37,20 @@ module Couchbase
       # @raise [Error::BucketExists]
       def create_bucket(settings, options = CreateBucketOptions.new)
         @backend.bucket_create(
-            {
-
-                name: settings.name,
-                flush_enabled: settings.flush_enabled,
-                ram_quota_mb: settings.ram_quota_mb,
-                num_replicas: settings.num_replicas,
-                replica_indexes: settings.replica_indexes,
-                bucket_type: settings.bucket_type,
-                ejection_policy: settings.ejection_policy,
-                max_expiry: settings.max_expiry,
-                compression_mode: settings.compression_mode,
-                conflict_resolution_type: settings.conflict_resolution_type,
-            }, options.timeout
+          {
+
+            name: settings.name,
+            flush_enabled: settings.flush_enabled,
+            ram_quota_mb: settings.ram_quota_mb,
+            num_replicas: settings.num_replicas,
+            replica_indexes: settings.replica_indexes,
+            bucket_type: settings.bucket_type,
+            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
         )
       end
 
@@ -62,17 +65,18 @@ module Couchbase
       # @raise [Error::BucketNotFound]
       def update_bucket(settings, options = UpdateBucketOptions.new)
         @backend.bucket_update(
-            {
-                name: settings.name,
-                flush_enabled: settings.flush_enabled,
-                ram_quota_mb: settings.ram_quota_mb,
-                num_replicas: settings.num_replicas,
-                replica_indexes: settings.replica_indexes,
-                bucket_type: settings.bucket_type,
-                ejection_policy: settings.ejection_policy,
-                max_expiry: settings.max_expiry,
-                compression_mode: settings.compression_mode,
-            }, options.timeout
+          {
+            name: settings.name,
+            flush_enabled: settings.flush_enabled,
+            ram_quota_mb: settings.ram_quota_mb,
+            num_replicas: settings.num_replicas,
+            replica_indexes: settings.replica_indexes,
+            bucket_type: settings.bucket_type,
+            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
 
@@ -109,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
@@ -188,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
@@ -196,6 +201,8 @@ module Couchbase
     end
 
     class BucketSettings
+      extend Gem::Deprecate
+
       # @return [String] name of the bucket
       attr_accessor :name
 
@@ -214,8 +221,25 @@ module Couchbase
       # @return [:couchbase, :memcached, :ephemeral] the type of the bucket. Defaults to +:couchbase+
       attr_accessor :bucket_type
 
-      # @return [:full, :value_only] the eviction policy to use
-      attr_accessor :ejection_policy
+      # Eviction policy to use
+      #
+      # :full:: During ejection, only the value will be ejected (key and metadata will remain in memory). Value Ejection
+      #         needs more system memory, but provides better performance than Full Ejection. This value is only valid for
+      #         buckets of type +:couchbase+.
+      #
+      # :value_only:: During ejection, everything (including key, metadata, and value) will be ejected. Full Ejection
+      #               reduces the memory overhead requirement, at the cost of performance. This value is only valid for
+      #               buckets of type +:couchbase+.
+      #
+      # :no_eviction:: Couchbase Server keeps all data until explicitly deleted, but will reject any new data if you
+      #                reach the quota (dedicated memory) you set for your bucket. This value is only valid for buckets
+      #                of type +:ephemeral+.
+      #
+      # :not_recently_used:: When the memory quota is reached, Couchbase Server ejects data that has not been used
+      #                      recently. This value is only valid for buckets of type +:ephemeral+.
+      #
+      # @return [:full, :value_only, :no_eviction, :not_recently_used] the eviction policy to use
+      attr_accessor :eviction_policy
 
       # @return [Integer] value of TTL (expiration) in seconds for new documents created without expiration
       attr_accessor :max_expiry
@@ -226,16 +250,32 @@ 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?
         @healthy
       end
 
+      # @deprecated Use {#eviction_policy} instead
+      def ejection_policy
+        @eviction_policy
+      end
+      deprecate :ejection_policy, :eviction_policy, 2021, 1
+
+      # @deprecated Use {#eviction_policy=} instead
+      def ejection_policy=(val)
+        @eviction_policy = val
+      end
+      deprecate :ejection_policy=, :eviction_policy=, 2021, 1
+
       # @yieldparam [BucketSettings] self
       def initialize
         @bucket_type = :couchbase
         @name = nil
+        @minimum_durability_level = nil
         @healthy = true
         @flush_enabled = false
         @ram_quota_mb = 100
@@ -244,7 +284,7 @@ module Couchbase
         @max_expiry = 0
         @compression_mode = :passive
         @conflict_resolution_type = :sequence_number
-        @ejection_policy = :value_only
+        @eviction_policy = :value_only
         yield self if block_given?
       end
     end

data/lib/couchbase/management/collection_manager.rb

@@ -17,7 +17,7 @@ require "couchbase/errors"
 module Couchbase
   module Management
     class CollectionManager
-      alias_method :inspect, :to_s
+      alias inspect to_s
 
       # @param [Couchbase::Backend] backend
       # @param [String] bucket_name
@@ -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
@@ -55,8 +55,8 @@ module Couchbase
       #
       # @raise [Error::ScopeNotFound]
       def get_scope(scope_name, options = GetScopeOptions.new)
-        get_all_scopes(GetAllScopesOptions.new {|o| o.timeout = options.timeout })
-            .find { |scope| scope.name == scope_name } or raise Error::ScopeNotFound, "unable to find scope #{scope_name}"
+        get_all_scopes(GetAllScopesOptions.new { |o| o.timeout = options.timeout })
+          .find { |scope| scope.name == scope_name } or raise Error::ScopeNotFound, "unable to find scope #{scope_name}"
       end
 
       # Creates a new scope

data/lib/couchbase/management/query_index_manager.rb

@@ -17,7 +17,7 @@ require "couchbase/errors"
 module Couchbase
   module Management
     class QueryIndexManager
-      alias_method :inspect, :to_s
+      alias inspect to_s
 
       # @param [Couchbase::Backend] backend
       def initialize(backend)
@@ -40,6 +40,9 @@ module Couchbase
             index.is_primary = idx[:is_primary]
             index.type = idx[:type]
             index.state = idx[:state]
+            index.bucket = idx[:bucket_id]
+            index.collection = idx[:collection_id]
+            index.scope = idx[:scope_id]
             index.key_space = idx[:keyspace_id]
             index.name_space = idx[:namespace_id]
             index.index_key = idx[:index_key]
@@ -61,10 +64,12 @@ module Couchbase
       # @raise [Error::IndexExists]
       def create_index(bucket_name, index_name, fields, options = CreateIndexOptions.new)
         @backend.query_index_create(bucket_name, index_name, fields, {
-            ignore_if_exists: options.ignore_if_exists,
-            condition: options.condition,
-            deferred: options.deferred,
-            num_replicas: options.num_replicas,
+          ignore_if_exists: options.ignore_if_exists,
+          condition: options.condition,
+          deferred: options.deferred,
+          num_replicas: options.num_replicas,
+          scope_name: options.scope_name,
+          collection_name: options.collection_name,
         }, options.timeout)
       end
 
@@ -79,9 +84,11 @@ module Couchbase
       # @raise [Error::IndexExists]
       def create_primary_index(bucket_name, options = CreatePrimaryIndexOptions.new)
         @backend.query_index_create_primary(bucket_name, {
-            ignore_if_exists: options.ignore_if_exists,
-            deferred: options.deferred,
-            num_replicas: options.num_replicas,
+          ignore_if_exists: options.ignore_if_exists,
+          deferred: options.deferred,
+          num_replicas: options.num_replicas,
+          scope_name: options.scope_name,
+          collection_name: options.collection_name,
         }, options.timeout)
       end
 
@@ -97,7 +104,9 @@ module Couchbase
       # @raise [Error::IndexNotFound]
       def drop_index(bucket_name, index_name, options = DropIndexOptions.new)
         @backend.query_index_drop(bucket_name, index_name, {
-            ignore_if_does_not_exist: options.ignore_if_does_not_exist,
+          ignore_if_does_not_exist: options.ignore_if_does_not_exist,
+          scope_name: options.scope_name,
+          collection_name: options.collection_name,
         }, options.timeout)
         true
       end
@@ -113,8 +122,10 @@ module Couchbase
       # @raise [Error::IndexNotFound]
       def drop_primary_index(bucket_name, options = DropPrimaryIndexOptions.new)
         @backend.query_index_drop_primary(bucket_name, {
-            ignore_if_does_not_exist: options.ignore_if_does_not_exist,
-            index_name: options.index_name,
+          ignore_if_does_not_exist: options.ignore_if_does_not_exist,
+          index_name: options.index_name,
+          scope_name: options.scope_name,
+          collection_name: options.collection_name,
         }, options.timeout)
         true
       end
@@ -135,13 +146,15 @@ module Couchbase
       #
       # @param [String] bucket_name name of the bucket
       # @param [Array<String>] index_names names of the indexes to watch
-      # @param [Integer] timeout
+      # @param [Integer, #in_milliseconds] timeout
       # @param [WatchIndexesOptions] options
       #
       # @raise [ArgumentError]
       # @raise [Error::IndexNotFound]
       def watch_indexes(bucket_name, index_names, timeout, options = WatchIndexesOptions.new)
-        @backend.query_index_watch(bucket_name, index_names, timeout, {})
+        @backend.query_index_watch(bucket_name, index_names, timeout, {
+          watch_primary: options.watch_primary,
+        })
       end
 
       class GetAllIndexOptions
@@ -170,6 +183,12 @@ module Couchbase
         # @return [String] condition to apply to the index
         attr_accessor :condition
 
+        # @return [String] the name of the scope
+        attr_accessor :scope_name
+
+        # @return [String] the name of the collection
+        attr_accessor :collection_name
+
         # @yieldparam [CreateIndexOptions] self
         def initialize
           @ignore_if_exists = false
@@ -193,6 +212,12 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @return [String] the name of the scope
+        attr_accessor :scope_name
+
+        # @return [String] the name of the collection
+        attr_accessor :collection_name
+
         # @yieldparam [CreatePrimaryIndexOptions] self
         def initialize
           @ignore_if_exists = false
@@ -207,6 +232,12 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @return [String] the name of the scope
+        attr_accessor :scope_name
+
+        # @return [String] the name of the collection
+        attr_accessor :collection_name
+
         # @yieldparam [DropIndexOptions] self
         def initialize
           @ignore_if_does_not_exist = false
@@ -224,6 +255,12 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @return [String] the name of the scope
+        attr_accessor :scope_name
+
+        # @return [String] the name of the collection
+        attr_accessor :collection_name
+
         # @yieldparam [DropPrimaryIndexOptions] self
         def initialize
           @ignore_if_does_not_exist = false
@@ -258,7 +295,7 @@ module Couchbase
 
       # @return [Boolean] true if this is a primary index
       attr_accessor :is_primary
-      alias_method :primary?, :is_primary
+      alias primary? is_primary
 
       # @return [:gsi, :view] type of the index
       attr_accessor :type
@@ -266,6 +303,15 @@ module Couchbase
       # @return [Symbol] state
       attr_accessor :state
 
+      # @return [String, nil] the name of the bucket
+      attr_accessor :bucket
+
+      # @return [String, nil] the name of the scope
+      attr_accessor :scope
+
+      # @return [String, nil] the name of the collection
+      attr_accessor :collection
+
       # @return [String] the key space for the index, typically the bucket name.
       attr_accessor :key_space
 
@@ -279,7 +325,6 @@ module Couchbase
       #   instance, it will show the indexed fields in an escaped format (surrounded by backticks).
       attr_accessor :index_key
 
-
       # @return [String] the string representation of the index's condition (the WHERE clause of the index),
       #   or an empty Optional if no condition was set.
       #