couchbase 3.0.0.alpha.3 → 3.0.0.alpha.4

data/ext/couchbase/version.hxx

@@ -18,7 +18,7 @@
 #pragma once
 
 #define BACKEND_VERSION_MAJOR 0
-#define BACKEND_VERSION_MINOR 3
+#define BACKEND_VERSION_MINOR 4
 #define BACKEND_VERSION_PATCH 0
 
 #include <build_version.hxx>

data/ext/test/main.cxx

@@ -44,23 +44,14 @@ main()
     rb_require("json");
     run_script(R"(
 p Couchbase::VERSION
-)");
-
-    run_script(R"(
 B = Couchbase::Backend.new
 B.open("localhost", "Administrator", "password")
-)");
 
-    run_script(R"(
-query = {
-    query: "hello"
-}
-p B.document_search("beers", JSON.generate(query), {})
+pp B.document_view("beer-sample", "test", "get_all", :development, {
+   keys: [JSON.generate("21st_amendment_brewery_cafe-563_stout")]
+})
 )");
 
-    run_script(R"(
-B.close
-)");
 
     ruby_finalize();
     return 0;

data/lib/couchbase/analytics_options.rb

@@ -0,0 +1,165 @@
+#    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.
+
+require 'couchbase/json_transcoder'
+
+module Couchbase
+  class Cluster
+    class AnalyticsOptions
+      # @return [Integer] Timeout in milliseconds
+      attr_accessor :timeout
+
+      # @return [String] Provides a custom client context ID for this query
+      attr_accessor :client_context_id
+
+      # @return [:not_bounded, :request_plus] specifies level of consistency for the query
+      attr_accessor :scan_consistency
+
+      # @return [Integer] The maximum duration (in milliseconds) the query engine is willing to wait before failing.
+      attr_accessor :scan_wait
+
+      # @return [Boolean] Allows explicitly marking a query as being readonly and not mutating and documents on the server side.
+      attr_accessor :readonly
+
+      # @return [Boolean] Allows to give certain requests higher priority than others
+      attr_accessor :priority
+
+      # @return [JsonTranscoder] transcoder to use on rows
+      attr_accessor :transcoder
+
+      # @yieldparam [AnalyticsOptions] self
+      def initialize
+        @transcoder = JsonTranscoder.new
+        @raw_parameters = {}
+        @positional_parameters = nil
+        @named_parameters = nil
+        @scan_consistency = nil
+        yield self if block_given?
+      end
+
+      # Sets positional parameters for the query
+      #
+      # @param [Array] positional the list of parameters that have to be substituted in the statement
+      def positional_parameters(positional)
+        @positional_parameters = positional
+        @named_parameters = nil
+      end
+
+      # Sets named parameters for the query
+      #
+      # @param [Hash] named the key/value map of the parameters to substitute in the statement
+      def named_parameters(named)
+        @named_parameters = named
+        @positional_parameters = nil
+      end
+
+      # Allows providing custom JSON key/value pairs for advanced usage
+      #
+      # @param [String] key the parameter name (key of the JSON property)
+      # @param [Object] value the parameter value (value of the JSON property)
+      def raw(key, value)
+        @raw_parameters[key] = JSON.generate(value)
+      end
+    end
+
+    class AnalyticsWarning
+      # @return [Integer]
+      attr_accessor :code
+
+      # @return [String]
+      attr_accessor :message
+
+      # @param [Integer] code
+      # @param [String] message
+      def initialize(code, message)
+        @code = code
+        @message = message
+      end
+    end
+
+    class AnalyticsMetrics
+      # @return [Integer] duration in milliseconds
+      attr_accessor :elapsed_time
+
+      # @return [Integer] duration in milliseconds
+      attr_accessor :execution_time
+
+      # @return [Integer]
+      attr_accessor :result_count
+
+      # @return [Integer]
+      attr_accessor :result_size
+
+      # @return [Integer]
+      attr_accessor :error_count
+
+      # @return [Integer]
+      attr_accessor :processed_objects
+
+      # @return [Integer]
+      attr_accessor :warning_count
+
+      # @yieldparam [AnalyticsMetrics] self
+      def initialize
+        yield self if block_given?
+      end
+    end
+
+    class AnalyticsMetaData
+      # @return [String]
+      attr_accessor :request_id
+
+      # @return [String]
+      attr_accessor :client_context_id
+
+      # @return [:running, :success, :errors, :completed, :stopped, :timeout, :closed, :fatal, :aborted, :unknown]
+      attr_accessor :status
+
+      # @return [Hash] returns the signature as returned by the query engine which is then decoded as JSON object
+      attr_accessor :signature
+
+      # @return [Array<AnalyticsWarning>]
+      attr_accessor :warnings
+
+      # @return [AnalyticsMetrics]
+      attr_accessor :metrics
+
+      # @yieldparam [AnalyticsMetaData] self
+      def initialize
+        yield self if block_given?
+      end
+    end
+
+    class AnalyticsResult
+      # @return [AnalyticsMetaData]
+      attr_accessor :meta_data
+
+      attr_accessor :transcoder
+
+      # Returns all rows converted using a transcoder
+      #
+      # @return [Array]
+      def rows(transcoder = self.transcoder)
+        @rows.lazy.map { |row| transcoder.decode(row, 0) }
+      end
+
+      # @yieldparam [AnalyticsResult] self
+      def initialize
+        @transcoder = JsonTranscoder.new
+        yield self if block_given?
+      end
+    end
+  end
+end
+

data/lib/couchbase/bucket.rb

@@ -14,6 +14,8 @@
 
 require "couchbase/scope"
 require "couchbase/management/collection_manager"
+require "couchbase/management/view_index_manager"
+require "couchbase/view_options"
 
 module Couchbase
   class Bucket
@@ -58,11 +60,58 @@ module Couchbase
       default_scope.default_collection
     end
 
+    # Performs query to view index.
+    #
+    # @param [String] design_document_name name of the design document
+    # @param [String] view_name name of the view to query
+    # @param [ViewOptions] options
+    #
+    # @return [ViewQueryResult]
+    def view_query(design_document_name, view_name, options = ViewOptions.new)
+      resp = @backend.document_view(@name, design_document_name, view_name, options.namespace, {
+          timeout: options.timeout,
+          scan_consistency: options.scan_consistency,
+          skip: options.skip,
+          limit: options.limit,
+          start_key: (JSON.generate(options.start_key) unless options.start_key.nil?),
+          end_key: (JSON.generate(options.end_key) unless options.end_key.nil?),
+          start_key_doc_id: options.start_key_doc_id,
+          end_key_doc_id: options.end_key_doc_id,
+          inclusive_end: options.inclusive_end,
+          group: options.group,
+          group_level: options.group_level,
+          key: (JSON.generate(options.key) unless options.key.nil?),
+          keys: options.keys&.map { |key| JSON.generate(key) },
+          order: options.order,
+          reduce: options.reduce,
+          on_error: options.on_error,
+          debug: options.debug,
+      })
+      ViewResult.new do |res|
+        res.meta_data = ViewMetaData.new do |meta|
+          meta.total_rows = resp[:meta][:total_rows]
+          meta.debug_info = resp[:meta][:debug_info]
+        end
+        res.rows = resp[:rows].map do |entry|
+          ViewRow.new do |row|
+            row.id = entry[:id] if entry.key?(:id)
+            row.key = JSON.parse(entry[:key])
+            row.value = JSON.parse(entry[:value])
+          end
+        end
+      end
+    end
+
     # @return [Management::CollectionManager]
     def collections
       Management::CollectionManager.new(@backend, @name)
     end
 
+    # @return [Management::ViewIndexManager]
+    def view_indexes
+      Management::ViewIndexManager.new(@backend, @name)
+    end
+
     # Performs application-level ping requests against services in the couchbase cluster
     #
     # @return [PingResult]

data/lib/couchbase/cluster.rb

@@ -22,6 +22,8 @@ require "couchbase/management/analytics_index_manager"
 require "couchbase/management/search_index_manager"
 
 require "couchbase/search_options"
+require "couchbase/query_options"
+require "couchbase/analytics_options"
 
 module Couchbase
   class Cluster
@@ -87,6 +89,7 @@ module Couchbase
               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]
@@ -104,7 +107,42 @@ module Couchbase
     # @param [AnalyticsOptions] options the custom options for this query
     #
     # @return [AnalyticsResult]
-    def analytics_query(statement, options = AnalyticsOptions.new) end
+    def analytics_query(statement, options = AnalyticsOptions.new)
+      resp = @backend.document_analytics(statement, {
+          timeout: options.timeout,
+          client_context_id: options.client_context_id,
+          scan_consistency: options.scan_consistency,
+          readonly: options.readonly,
+          priority: options.priority,
+          positional_parameters: options.instance_variable_get("@positional_parameters")&.map { |p| JSON.dump(p) },
+          named_parameters: options.instance_variable_get("@named_parameters")&.each_with_object({}) { |(n, v), o| o[n.to_s] = JSON.dump(v) },
+          raw_parameters: options.instance_variable_get("@raw_parameters"),
+      })
+
+      AnalyticsResult.new do |res|
+        res.transcoder = options.transcoder
+        res.meta_data = AnalyticsMetaData.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 = AnalyticsMetrics.new do |metrics|
+            if resp[:meta][:metrics]
+              metrics.elapsed_time = resp[:meta][:metrics][:elapsed_time]
+              metrics.execution_time = resp[:meta][:metrics][:execution_time]
+              metrics.result_count = resp[:meta][:metrics][:result_count]
+              metrics.result_size = resp[:meta][:metrics][:result_size]
+              metrics.error_count = resp[:meta][:metrics][:error_count]
+              metrics.warning_count = resp[:meta][:metrics][:warning_count]
+              metrics.processed_objects = resp[:meta][:metrics][:processed_objects]
+            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
 
     # Performs a Full Text Search (FTS) query
     #
@@ -243,210 +281,6 @@ module Couchbase
       end
     end
 
-    class QueryOptions
-      # @return [Integer] Timeout in milliseconds
-      attr_accessor :timeout
-
-      # @return [Boolean] Allows turning this request into a prepared statement query
-      attr_accessor :adhoc
-
-      # @return [String] Provides a custom client context ID for this query
-      attr_accessor :client_context_id
-
-      # @return [Integer] Allows overriding the default maximum parallelism for the query execution on the server side.
-      attr_accessor :max_parallelism
-
-      # @return [Boolean] Allows explicitly marking a query as being readonly and not mutating and 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.
-      #
-      # @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.
-      #
-      # @return [Integer] The maximum duration (in milliseconds) the query engine is willing to wait before failing.
-      attr_accessor :scan_wait
-
-      # @return [Integer] Supports customizing the maximum buffered channel size between the indexer and the query service
-      attr_accessor :scan_cap
-
-      # @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.
-      attr_accessor :pipeline_cap
-
-      # @return [Boolean] Enables per-request metrics in the trailing section of the query
-      attr_accessor :metrics
-
-      # @return [:off, :phases, :timings] Customize server profile level for this query
-      attr_accessor :profile
-
-      def initialize
-        @timeout = 75_000 # ms
-        @adhoc = true
-        @raw_parameters = {}
-        @positional_parameters = nil
-        @named_parameters = nil
-        @scan_consistency = nil
-        @mutation_state = nil
-        yield self if block_given?
-      end
-
-      # Allows providing custom JSON key/value pairs for advanced usage
-      #
-      # @param [String] key the parameter name (key of the JSON property)
-      # @param [Object] value the parameter value (value of the JSON property)
-      def raw(key, value)
-        @raw_parameters[key] = JSON.generate(value)
-      end
-
-      # Customizes the consistency guarantees for this query
-      #
-      # @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).
-      #
-      # [+: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)
-        @mutation_state = nil if @mutation_state
-        @scan_consistency = level
-      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)
-        @scan_consistency = nil if @scan_consistency
-        @mutation_state = mutation_state
-      end
-
-      # Sets positional parameters for the query
-      #
-      # @param [Array] positional the list of parameters that have to be substituted in the statement
-      def positional_parameters(positional)
-        @positional_parameters = positional
-        @named_parameters = nil
-      end
-
-      # Sets named parameters for the query
-      #
-      # @param [Hash] named the key/value map of the parameters to substitute in the statement
-      def named_parameters(named)
-        @named_parameters = named
-        @positional_parameters = nil
-      end
-    end
-
-    class QueryResult
-      # @return [QueryMetaData] returns object representing additional metadata associated with this query
-      attr_accessor :meta_data
-
-      attr_accessor :transcoder
-
-      # Returns all rows converted using a transcoder
-      #
-      # @return [Array]
-      def rows(transcoder = self.transcoder)
-        @rows.lazy.map do |row|
-          if transcoder == :json
-            JSON.parse(row)
-          else
-            transcoder.call(row)
-          end
-        end
-      end
-
-      # @yieldparam [QueryResult] self
-      def initialize
-        yield self if block_given?
-        @transcoder = :json
-      end
-    end
-
-    class QueryMetaData
-      # @return [String] returns the request identifier string of the query request
-      attr_accessor :request_id
-
-      # @return [String] returns the client context identifier string set of the query request
-      attr_accessor :client_context_id
-
-      # @return [Symbol] returns raw query execution status as returned by the query engine
-      attr_accessor :status
-
-      # @return [Hash] returns the signature as returned by the query engine which is then decoded as JSON object
-      attr_accessor :signature
-
-      # @return [Hash] returns the profiling information returned by the query engine which is then decoded as JSON object
-      attr_accessor :profile
-
-      # @return [QueryMetrics] metrics as returned by the query engine, if enabled
-      attr_accessor :metrics
-
-      # @return [List<QueryWarning>] list of warnings returned by the query engine
-      attr_accessor :warnings
-
-      # @yieldparam [QueryMetaData] self
-      def initialize
-        yield self if block_given?
-      end
-    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
-      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
-      attr_accessor :execution_time
-
-      # @return [Integer] the total number of results selected by the engine before restriction through LIMIT clause.
-      attr_accessor :sort_count
-
-      # @return [Integer] The total number of objects in the results.
-      attr_accessor :result_count
-
-      # @return [Integer] The total number of bytes in the results.
-      attr_accessor :result_size
-
-      # @return [Integer] The number of mutations that were made during the request.
-      attr_accessor :mutation_count
-
-      # @return [Integer] The number of errors that occurred during the request.
-      attr_accessor :error_count
-
-      # @return [Integer] The number of warnings that occurred during the request.
-      attr_accessor :warning_count
-
-      # @yieldparam [QueryMetrics] self
-      def initialize
-        yield self if block_given?
-      end
-    end
-
-    # Represents a single warning returned from the query engine.
-    class QueryWarning
-      # @return [Integer]
-      attr_accessor :code
-
-      # @return [String]
-      attr_accessor :message
-
-      def initialize(code, message)
-        @code = code
-        @message = message
-      end
-    end
-
-    class AnalyticsOptions
-      def initialize
-        yield self if block_given?
-      end
-    end
-
     class DiagnosticsOptions
       # @return [String] Holds custom report id.
       attr_accessor :report_id
@@ -458,9 +292,14 @@ module Couchbase
 
     private
 
+    # Initialize {Cluster} object
+    #
+    # @param [String] connection_string connection string used to locate the Couchbase Cluster
+    # @param [ClusterOptions] options custom options when creating the cluster connection
     def initialize(connection_string, options)
-      hostname = connection_string[%r{^couchbase://(.*)}, 1]
-      raise ArgumentError, "missing hostname" unless hostname
+      conn_info = Backend.parse_connection_string(connection_string)
+      raise ArgumentError, "missing hostname" if conn_info[:nodes].empty?
+      hostname = conn_info[:nodes].first[:address]
       raise ArgumentError, "options must have authenticator configured" unless options.authenticator
       username = options.authenticator.username
       raise ArgumentError, "missing username" unless username