couchbase 3.0.0.beta.1 → 3.0.0

data/lib/couchbase/management/search_index_manager.rb

@@ -17,7 +17,7 @@ require "couchbase/errors"
 module Couchbase
   module Management
     class SearchIndexManager
-      alias_method :inspect, :to_s
+      alias inspect to_s
 
       # @param [Couchbase::Backend] backend
       def initialize(backend)
@@ -58,17 +58,18 @@ module Couchbase
       # @raise [ArgumentError] if name, type or source_type is empty
       def upsert_index(index_definition, options = UpsertIndexOptions.new)
         @backend.search_index_upsert(
-            {
-                name: index_definition.name,
-                type: index_definition.type,
-                uuid: index_definition.uuid,
-                params: (JSON.generate(index_definition.params) if index_definition.params),
-                source_name: index_definition.source_name,
-                source_type: index_definition.source_type,
-                source_uuid: index_definition.source_uuid,
-                source_params: (JSON.generate(index_definition.source_params) if index_definition.source_params),
-                plan_params: (JSON.generate(index_definition.plan_params) if index_definition.plan_params),
-            }, options.timeout)
+          {
+            name: index_definition.name,
+            type: index_definition.type,
+            uuid: index_definition.uuid,
+            params: (JSON.generate(index_definition.params) if index_definition.params),
+            source_name: index_definition.source_name,
+            source_type: index_definition.source_type,
+            source_uuid: index_definition.source_uuid,
+            source_params: (JSON.generate(index_definition.source_params) if index_definition.source_params),
+            plan_params: (JSON.generate(index_definition.plan_params) if index_definition.plan_params),
+          }, options.timeout
+        )
       end
 
       # Drops the index
@@ -357,6 +358,8 @@ module Couchbase
 
       # @yieldparam [SearchIndex] self
       def initialize
+        @type = "fulltext-index"
+        @source_type = "couchbase"
         yield self if block_given?
       end
     end

data/lib/couchbase/management/user_manager.rb

@@ -17,7 +17,7 @@ require "couchbase/errors"
 module Couchbase
   module Management
     class UserManager
-      alias_method :inspect, :to_s
+      alias inspect to_s
 
       # @param [Couchbase::Backend] backend
       def initialize(backend)

data/lib/couchbase/management/view_index_manager.rb

@@ -32,7 +32,7 @@ module Couchbase
     # development document or a production document. The type of this argument is [Symbol] with allowed values
     # +:production+ and +:development+.
     class ViewIndexManager
-      alias_method :inspect, :to_s
+      alias inspect to_s
 
       # @return [String] name of the bucket
       attr_accessor :bucket_name
@@ -80,8 +80,14 @@ module Couchbase
       # @return [void]
       def upsert_design_document(document, namespace, options = UpsertDesignDocumentOptions.new)
         @backend.view_index_upsert(@bucket_name, {
-            name: document.name,
-            views: document.views.map { |name, view| {name: name, map: view.map_function, reduce: view.reduce_function} }
+          name: document.name,
+          views: document.views.map do |name, view|
+            {
+              name: name,
+              map: view.map_function,
+              reduce: view.reduce_function,
+            }
+          end,
         }, namespace, options.timeout)
       end
 
@@ -184,11 +190,11 @@ module Couchbase
 
       # @return [String] map function in javascript as String
       attr_accessor :map_function
-      alias_method :map, :map_function
+      alias map map_function
 
       # @return [String] reduce function in javascript as String
       attr_accessor :reduce_function
-      alias_method :reduce, :reduce_function
+      alias reduce reduce_function
 
       # @return [Boolean] true if map function is defined
       def has_map?

data/lib/couchbase/mutation_state.rb

@@ -47,5 +47,17 @@ module Couchbase
     def add(*mutation_tokens)
       @tokens |= mutation_tokens
     end
+
+    # @api private
+    def to_a
+      @tokens.map do |t|
+        {
+          bucket_name: t.bucket_name,
+          partition_id: t.partition_id,
+          partition_uuid: t.partition_uuid,
+          sequence_number: t.sequence_number,
+        }
+      end
+    end
   end
 end

data/lib/couchbase/query_options.rb

@@ -16,7 +16,6 @@ require 'json'
 
 module Couchbase
   class Cluster
-
     class QueryOptions
       # @return [Integer] Timeout in milliseconds
       attr_accessor :timeout
@@ -33,7 +32,8 @@ module Couchbase
       # @return [Boolean] Allows explicitly marking a query as being readonly and not mutating any documents on the server side.
       attr_accessor :readonly
 
-      # Allows customizing how long (in milliseconds) the query engine is willing to wait until the index catches up to whatever scan consistency is asked for in this query.
+      # Allows customizing how long (in milliseconds) the query engine is willing to wait until the index catches up to whatever scan
+      # consistency is asked for in this query.
       #
       # @note that if +:not_bounded+ consistency level is used, this method doesn't do anything
       # at all. If no value is provided to this method, the server default is used.
@@ -47,7 +47,8 @@ module Couchbase
       # @return [Integer] Supports customizing the number of items execution operators can batch for fetch from the KV layer on the server.
       attr_accessor :pipeline_batch
 
-      # @return [Integer] Allows customizing the maximum number of items each execution operator can buffer between various operators on the server.
+      # @return [Integer] Allows customizing the maximum number of items each execution operator can buffer between various operators on the
+      #   server.
       attr_accessor :pipeline_cap
 
       # @return [Boolean] Enables per-request metrics in the trailing section of the query
@@ -56,6 +57,14 @@ module Couchbase
       # @return [:off, :phases, :timings] Customize server profile level for this query
       attr_accessor :profile
 
+      # 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}+.
+      #
+      # @api uncommitted
+      # @return [String]
+      attr_accessor :scope_qualifier
+
       # @return [:not_bounded, :request_plus]
       attr_reader :scan_consistency
 
@@ -76,6 +85,7 @@ module Couchbase
         @named_parameters = nil
         @scan_consistency = nil
         @mutation_state = nil
+        @scope_qualifier = nil
         yield self if block_given?
       end
 
@@ -91,9 +101,11 @@ module Couchbase
       #
       # @note overrides consistency level set by {#consistent_with}
       #
-      # [+:not_bounded+] The indexer will return whatever state it has to the query engine at the time of query. This is the default (for single-statement requests).
+      # [+:not_bounded+] The indexer will return whatever state it has to the query engine at the time of query. This is the default (for
+      #   single-statement requests).
       #
-      # [+:request_plus+] The indexer will wait until all mutations have been processed at the time of request before returning to the query engine.
+      # [+:request_plus+] The indexer will wait until all mutations have been processed at the time of request before returning to the query
+      #   engine.
       #
       # @param [:not_bounded, :request_plus] level the index scan consistency to be used for this query
       def scan_consistency=(level)
@@ -122,7 +134,7 @@ module Couchbase
       # @api private
       # @return [Array<String>, nil]
       def export_positional_parameters
-        @positional_parameters.map { |p| JSON.dump(p) } if @positional_parameters
+        @positional_parameters&.map { |p| JSON.dump(p) }
       end
 
       # Sets named parameters for the query
@@ -136,7 +148,7 @@ module Couchbase
       # @api private
       # @return [Hash<String => String>, nil]
       def export_named_parameters
-        @named_parameters.each_with_object({}) { |(n, v), o| o[n.to_s] = JSON.dump(v) } if @named_parameters
+        @named_parameters&.each_with_object({}) { |(n, v), o| o[n.to_s] = JSON.dump(v) }
       end
     end
 
@@ -195,10 +207,12 @@ module Couchbase
     end
 
     class QueryMetrics
-      # @return [Integer] The total time taken for the request, that is the time from when the request was received until the results were returned
+      # @return [Integer] The total time taken for the request, that is the time from when the request was received until the results were
+      #   returned.
       attr_accessor :elapsed_time
 
-      # @return [Integer] The time taken for the execution of the request, that is the time from when query execution started until the results were returned
+      # @return [Integer] The time taken for the execution of the request, that is the time from when query execution started until the
+      #   results were returned
       attr_accessor :execution_time
 
       # @return [Integer] the total number of results selected by the engine before restriction through LIMIT clause.

data/lib/couchbase/scope.rb

@@ -13,13 +13,14 @@
 #  limitations under the License.
 
 require "couchbase/collection"
+require "couchbase/query_options"
 
 module Couchbase
   class Scope
     attr_reader :bucket_name
     attr_reader :name
 
-    alias_method :inspect, :to_s
+    alias inspect to_s
 
     # @param [Couchbase::Backend] backend
     # @param [String] bucket_name name of the bucket
@@ -38,5 +39,64 @@ module Couchbase
     def collection(collection_name)
       Collection.new(@backend, @bucket_name, @name, collection_name)
     end
+
+    # Performs a query against the query (N1QL) services.
+    #
+    # The query will be implicitly scoped using current bucket and scope names.
+    #
+    # @see QueryOptions#scope_qualifier
+    # @see Cluster#query
+    #
+    # @param [String] statement the N1QL query statement
+    # @param [QueryOptions] options the custom options for this query
+    #
+    # @return [QueryResult]
+    def query(statement, options = Cluster::QueryOptions.new)
+      resp = @backend.document_query(statement, {
+        timeout: options.timeout,
+        adhoc: options.adhoc,
+        client_context_id: options.client_context_id,
+        max_parallelism: options.max_parallelism,
+        readonly: options.readonly,
+        scan_wait: options.scan_wait,
+        scan_cap: options.scan_cap,
+        pipeline_batch: options.pipeline_batch,
+        pipeline_cap: options.pipeline_cap,
+        metrics: options.metrics,
+        profile: options.profile,
+        positional_parameters: options.export_positional_parameters,
+        named_parameters: options.export_named_parameters,
+        scope_name: @name,
+        bucket_name: @bucket_name,
+        scope_qualifier: options.scope_qualifier,
+        raw_parameters: options.raw_parameters,
+        scan_consistency: options.scan_consistency,
+        mutation_state: options.mutation_state&.to_a,
+      })
+
+      Cluster::QueryResult.new do |res|
+        res.meta_data = Cluster::QueryMetaData.new do |meta|
+          meta.status = resp[:meta][:status]
+          meta.request_id = resp[:meta][:request_id]
+          meta.client_context_id = resp[:meta][:client_context_id]
+          meta.signature = JSON.parse(resp[:meta][:signature]) if resp[:meta][:signature]
+          meta.profile = JSON.parse(resp[:meta][:profile]) if resp[:meta][:profile]
+          meta.metrics = Cluster::QueryMetrics.new do |metrics|
+            if resp[:meta][:metrics]
+              metrics.elapsed_time = resp[:meta][:metrics][:elapsed_time]
+              metrics.execution_time = resp[:meta][:metrics][:execution_time]
+              metrics.sort_count = resp[:meta][:metrics][:sort_count]
+              metrics.result_count = resp[:meta][:metrics][:result_count]
+              metrics.result_size = resp[:meta][:metrics][:result_size]
+              metrics.mutation_count = resp[:meta][:metrics][:mutation_count]
+              metrics.error_count = resp[:meta][:metrics][:error_count]
+              metrics.warning_count = resp[:meta][:metrics][:warning_count]
+            end
+          end
+          res[:warnings] = resp[:warnings].map { |warn| QueryWarning.new(warn[:code], warn[:message]) } if resp[:warnings]
+        end
+        res.instance_variable_set("@rows", resp[:rows])
+      end
+    end
   end
 end

data/lib/couchbase/search_options.rb

@@ -304,7 +304,8 @@ module Couchbase
         #
         # @note The lower boundary is considered inclusive by default on the server side.
         #
-        # @param [Time, String] time_point start time. When +Time+ object is passed {#date_time_parser} must be +nil+ (to use server default)
+        # @param [Time, String] time_point start time. When +Time+ object is passed {#date_time_parser} must be +nil+ (to use server
+        #   default)
         # @param [Boolean] inclusive
         def start_time(time_point, inclusive = nil)
           @start_time = time_point
@@ -332,13 +333,11 @@ module Couchbase
           yield self if block_given?
         end
 
-        DATE_FORMAT_RFC3339 = "%Y-%m-%dT%H:%M:%S%:z"
+        DATE_FORMAT_RFC3339 = "%Y-%m-%dT%H:%M:%S%:z".freeze
 
         # @return [String]
         def to_json(*args)
-          if @start_time.nil? && @end_time.nil?
-            raise ArgumentError, "either start_time or end_time must be set for DateRangeQuery"
-          end
+          raise ArgumentError, "either start_time or end_time must be set for DateRangeQuery" if @start_time.nil? && @end_time.nil?
 
           data = {}
           data["boost"] = boost if boost
@@ -415,9 +414,7 @@ module Couchbase
 
         # @return [String]
         def to_json(*args)
-          if @min.nil? && @max.nil?
-            raise ArgumentError, "either min or max must be set for NumericRangeQuery"
-          end
+          raise ArgumentError, "either min or max must be set for NumericRangeQuery" if @min.nil? && @max.nil?
 
           data = {}
           data["boost"] = boost if boost
@@ -485,9 +482,7 @@ module Couchbase
 
         # @return [String]
         def to_json(*args)
-          if @min.nil? && @max.nil?
-            raise ArgumentError, "either min or max must be set for TermRangeQuery"
-          end
+          raise ArgumentError, "either min or max must be set for TermRangeQuery" if @min.nil? && @max.nil?
 
           data = {}
           data["boost"] = boost if boost
@@ -540,8 +535,8 @@ module Couchbase
         # @return [String]
         def to_json(*args)
           data = {
-              "location" => [@longitude, @latitude],
-              "distance" => @distance
+            "location" => [@longitude, @latitude],
+            "distance" => @distance,
           }
           data["boost"] = boost if boost
           data["field"] = field if field
@@ -589,8 +584,8 @@ module Couchbase
         # @return [String]
         def to_json(*args)
           data = {
-              "top_left" => [@top_left_longitude, @top_left_latitude],
-              "bottom_right" => [@bottom_right_longitude, @bottom_right_latitude]
+            "top_left" => [@top_left_longitude, @top_left_latitude],
+            "bottom_right" => [@bottom_right_longitude, @bottom_right_latitude],
           }
           data["boost"] = boost if boost
           data["field"] = field if field
@@ -633,6 +628,7 @@ module Couchbase
         # @return [String]
         def to_json(*args)
           raise ArgumentError, "compound conjunction query must have sub-queries" if @queries.nil? || @queries.empty?
+
           data = {"conjuncts" => @queries.uniq}
           data["boost"] = boost if boost
           data.to_json(*args)
@@ -677,9 +673,11 @@ module Couchbase
         # @return [String]
         def to_json(*args)
           raise ArgumentError, "compound disjunction query must have sub-queries" if @queries.nil? || @queries.empty?
+
           data = {"disjuncts" => @queries.uniq}
           if min
             raise ArgumentError, "disjunction query has fewer sub-queries than configured minimum" if @queries.size < min
+
             data["min"] = min
           end
           data["boost"] = boost if boost
@@ -739,6 +737,7 @@ module Couchbase
           if @must.empty? && @must_not.empty? && @should.empty?
             raise ArgumentError, "BooleanQuery must have at least one non-empty sub-query"
           end
+
           data = {}
           data["must"] = @must unless @must.empty?
           data["must_not"] = @must_not unless @must_not.empty?
@@ -758,7 +757,8 @@ module Couchbase
         TermQuery.new(term, &block)
       end
 
-      # A query that looks for **exact** matches of the term in the index (no analyzer, no stemming). Useful to check what the actual content of the index is. It can also apply fuzziness on the term. Usual better alternative is `MatchQuery`.
+      # A query that looks for **exact** matches of the term in the index (no analyzer, no stemming). Useful to check what the actual
+      # content of the index is. It can also apply fuzziness on the term. Usual better alternative is `MatchQuery`.
       class TermQuery < SearchQuery
         # @return [Float]
         attr_accessor :boost
@@ -840,7 +840,8 @@ module Couchbase
         PhraseQuery.new(*terms, &block)
       end
 
-      # A query that looks for **exact** match of several terms (in the exact order) in the index. Usual better alternative is {MatchPhraseQuery}.
+      # A query that looks for **exact** match of several terms (in the exact order) in the index. Usual better alternative is
+      # {MatchPhraseQuery}.
       class PhraseQuery < SearchQuery
         # @return [Float]
         attr_accessor :boost
@@ -958,6 +959,7 @@ module Couchbase
 
         # @yieldparam [SearchSortScore]
         def initialize
+          super
           yield self if block_given?
         end
 
@@ -973,6 +975,7 @@ module Couchbase
 
         # @yieldparam [SearchSortId]
         def initialize
+          super
           yield self if block_given?
         end
 
@@ -1001,6 +1004,7 @@ module Couchbase
         # @param [String] field the name of the filed for ordering
         # @yieldparam [SearchSortField]
         def initialize(field)
+          super()
           @field = field
           yield self if block_given?
         end
@@ -1032,6 +1036,7 @@ module Couchbase
         # @param [Float] latitude
         # @yieldparam [SearchSortGeoDistance]
         def initialize(field, longitude, latitude)
+          super()
           @field = field
           @longitude = longitude
           @latitude = latitude
@@ -1119,19 +1124,20 @@ module Couchbase
 
         # @param [String] field name of the field
         def initialize(field)
+          super()
           @field = field
           @ranges = []
           yield self if block_given?
         end
 
-        DATE_FORMAT_RFC3339 = "%Y-%m-%dT%H:%M:%S%:z"
+        DATE_FORMAT_RFC3339 = "%Y-%m-%dT%H:%M:%S%:z".freeze
 
         # @param [String] name the name of the range
         # @param [Time, String, nil] start_time lower bound of the range (pass +nil+ if there is no lower bound)
         # @param [Time, String, nil] end_time lower bound of the range (pass +nil+ if there is no lower bound)
         def add(name, start_time, end_time)
-          start_time = start_time.strftime(DATE_FORMAT_RFC3339) if start_time && start_time.respond_to?(:strftime)
-          end_time = end_time.strftime(DATE_FORMAT_RFC3339) if end_time && end_time.respond_to?(:strftime)
+          start_time = start_time.strftime(DATE_FORMAT_RFC3339) if start_time.respond_to?(:strftime)
+          end_time = end_time.strftime(DATE_FORMAT_RFC3339) if end_time.respond_to?(:strftime)
           @ranges.append({name: name, start: start_time, end: end_time})
         end
 
@@ -1161,7 +1167,8 @@ module Couchbase
       # @return [Array<String>] list of the fields to highlight
       attr_accessor :highlight_fields
 
-      # @return [Array<String>] list of field values which should be retrieved for result documents, provided they were stored while indexing
+      # @return [Array<String>] list of field values which should be retrieved for result documents, provided they were stored while
+      #   indexing
       attr_accessor :fields
 
       # @return [:not_bounded] specifies level of consistency for the query
@@ -1201,7 +1208,8 @@ module Couchbase
       #
       # The list might contain either strings or special objects, that derive from {SearchSort}.
       #
-      # In case of String, the value represents the name of the field with optional +-+ in front of the name, which will turn on descending mode for this field. One field is special is +"_score"+ which will sort results by their score.
+      # In case of String, the value represents the name of the field with optional +-+ in front of the name, which will turn on descending
+      # mode for this field. One field is special is +"_score"+ which will sort results by their score.
       #
       # When nothing specified, the Server will order results by their score descending, which is equivalent of +"-_score"+.
       #
@@ -1218,6 +1226,7 @@ module Couchbase
 
       # @yieldparam [SearchOptions] self
       def initialize
+        super
         @explain = false
         @transcoder = JsonTranscoder.new
         @scan_consistency = nil
@@ -1272,31 +1281,31 @@ module Couchbase
       #
       # @return [Array<String>]
       def fields
-        @locations.map { |location| location.field }.uniq
+        @locations.map(&:field).uniq
       end
 
       # Lists all terms in this locations, considering all fields
       #
       # @return [Array<String>]
       def terms
-        @locations.map { |location| location.term }.uniq
+        @locations.map(&:term).uniq
       end
 
       # Lists the terms for a given field
       #
       # @return [Array<String>]
       def terms_for_field(name)
-        get_for_field(name).map { |location| location.term }.uniq
+        get_for_field(name).map(&:term).uniq
       end
 
       # @param [Array<SearchRowLocation>] locations
       def initialize(locations)
+        super()
         @locations = locations
       end
     end
 
-    # An individual facet result has both metadata and details, as each facet can define ranges into which results are
-    # categorized
+    # An individual facet result has both metadata and details, as each facet can define ranges into which results are categorized
     class SearchFacetResult
       # @return [String]
       attr_accessor :name
@@ -1323,6 +1332,7 @@ module Couchbase
 
         # @yieldparam [TermFacetResult] self
         def initialize
+          super
           yield self if block_given?
         end
 
@@ -1334,6 +1344,7 @@ module Couchbase
           attr_reader :count
 
           def initialize(term, count)
+            super()
             @term = term
             @count = count
           end
@@ -1350,6 +1361,7 @@ module Couchbase
 
         # @yieldparam [DateRangeFacetResult] self
         def initialize
+          super
           yield self if block_given?
         end
 
@@ -1385,6 +1397,7 @@ module Couchbase
 
         # @yieldparam [NumericRangeFacetResult] self
         def initialize
+          super
           yield self if block_given?
         end