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

data/lib/couchbase/query_options.rb

@@ -0,0 +1,219 @@
+#    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 'json'
+
+module Couchbase
+  class Cluster
+
+    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
+
+      # @yieldparam [QueryOptions] self
+      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
+  end
+end

data/lib/couchbase/search_options.rb

@@ -304,7 +304,7 @@ 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
@@ -315,7 +315,7 @@ module Couchbase
         #
         # @note The upper boundary is considered exclusive by default on the server side.
         #
-        # @param [Time, String] time_point end time. When {Time} object is passed {#date_time_parser} must be +nil+ (to use server default)
+        # @param [Time, String] time_point end time. When +Time+ object is passed {#date_time_parser} must be +nil+ (to use server default)
         # @param [Boolean] inclusive
         def end_time(time_point, inclusive = nil)
           @end_time = time_point
@@ -1203,7 +1203,7 @@ module Couchbase
 
       # Facets allow to aggregate information collected on a particular result set
       #
-      # @return [Hash<String, SearchFacet]
+      # @return [Hash<String => SearchFacet>]
       attr_accessor :facets
 
       # @return [JsonTranscoder] transcoder to use for the results
@@ -1420,7 +1420,7 @@ module Couchbase
       # @return [Hash]
       attr_accessor :explanation
 
-      # @return [Hash<String, Array<String>>]
+      # @return [Hash<String => Array<String>>]
       attr_accessor :fragments
 
       # @return [JsonTranscoder] transcoder to use for the fields
@@ -1463,7 +1463,7 @@ module Couchbase
       # @return [SearchMetrics]
       attr_accessor :metrics
 
-      # @return [Hash<String, String>]
+      # @return [Hash<String => String>]
       attr_accessor :errors
 
       # @yieldparam [SearchMetaData] self
@@ -1477,7 +1477,7 @@ module Couchbase
       # @return [Array<SearchRow>]
       attr_accessor :rows
 
-      # @return [Hash<String, SearchFacetResult>]
+      # @return [Hash<String => SearchFacetResult>]
       attr_accessor :facets
 
       # @return [SearchMetaData]

data/lib/couchbase/version.rb

@@ -14,5 +14,5 @@
 
 module Couchbase
   VERSION = {} unless defined?(VERSION)
-  VERSION.update(:sdk => "3.0.0.alpha.3".freeze)
+  VERSION.update(:sdk => "3.0.0.alpha.4".freeze)
 end

data/lib/couchbase/view_options.rb

@@ -0,0 +1,155 @@
+#    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 'json'
+
+module Couchbase
+  class Bucket
+
+    class ViewOptions
+      # @return [Integer] Timeout in milliseconds
+      attr_accessor :timeout
+
+      # Specifies the level of consistency for the query
+      # @return [:not_bounded, :request_plus, :update_after]
+      attr_accessor :scan_consistency
+
+      # Specifies the number of results to skip from the start of the result set
+      # @return [Integer]
+      attr_accessor :skip
+
+      # Specifies the maximum number of results to return
+      # @return [Integer]
+      attr_accessor :limit
+
+      # Specifies the key, to which the engine has to skip before result generation
+      attr_accessor :start_key
+
+      # Specifies the key, at which the result generation has to be stopped
+      # @return [#to_json]
+      attr_accessor :end_key
+
+      # Specifies the document id in case {#start_key} gives multiple results within the index
+      # @return [String]
+      attr_accessor :start_key_doc_id
+
+      # Specifies the document id in case {#end_key} gives multiple results within the index
+      # @return [String]
+      attr_accessor :end_key_doc_id
+
+      # Specifies whether the {#end_key}/#{#end_key_doc_id} values should be inclusive
+      # @return [Boolean]
+      attr_accessor :inclusive_end
+
+      # Specifies whether to enable grouping of the results
+      #
+      # @return [Boolean]
+      attr_accessor :group
+
+      # Specifies the depth within the key to group the results
+      #
+      # @return [Integer]
+      attr_accessor :group_level
+
+      # Specifies the set of the keys to fetch from the index
+      # @return [#to_json]
+      attr_accessor :key
+
+      # Specifies set of the keys to fetch from the index
+      #
+      # @return [Array<#to_json>]
+      attr_accessor :keys
+
+      # Specifies the order of the results that should be returned
+      #
+      # @return [:ascending, :descending]
+      attr_accessor :order
+
+      # Specifies whether to enable the reduction function associated with this particular view index
+      # @return [Boolean]
+      attr_accessor :reduce
+
+      # Specifies the behaviour of the view engine should an error occur during the gathering of view index results
+      # which would result in only partial results being available
+      #
+      # @return [:stop, :continue]
+      attr_accessor :on_error
+
+      # @return [Boolean] allows to return debug information as part of the view response
+      attr_accessor :debug
+
+      # @return [:production, :development]
+      attr_accessor :namespace
+
+      # @yieldparam [ViewQueryOptions] self
+      def initialize
+        @namespace = :production
+        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
+    end
+
+    class ViewRow
+      # @return [String]
+      attr_accessor :id
+
+      # @return [#to_json]
+      attr_accessor :key
+
+      # @return [#to_json]
+      attr_accessor :value
+
+      # @yieldparam [ViewRow] self
+      def initialize
+        yield self if block_given?
+      end
+    end
+
+    class ViewMetaData
+      # @return [Integer]
+      attr_accessor :total_rows
+
+      attr_writer :debug_info
+
+      def debug_info
+        JSON.parse(@debug_info)
+      end
+
+      # @yieldparam [ViewMetaData] self
+      def initialize
+        yield self if block_given?
+      end
+    end
+
+    class ViewResult
+      # @return [QueryMetaData] returns object representing additional metadata associated with this query
+      attr_accessor :meta_data
+
+      # @return [Array<ViewRow>]
+      attr_accessor :rows
+
+      # @yieldparam [ViewResult] self
+      def initialize
+        yield self if block_given?
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: couchbase
 version: !ruby/object:Gem::Version
-  version: 3.0.0.alpha.3
+  version: 3.0.0.alpha.4
 platform: ruby
 authors:
 - Sergey Avseyev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-12 00:00:00.000000000 Z
+date: 2020-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -88,19 +88,25 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/check-cluster
 - bin/console
 - bin/init-cluster
 - bin/setup
 - couchbase.gemspec
+- examples/analytics.rb
 - examples/crud.rb
+- examples/managing_analytics_indexes.rb
 - examples/managing_buckets.rb
 - examples/managing_collections.rb
 - examples/managing_query_indexes.rb
 - examples/managing_search_indexes.rb
+- examples/managing_view_indexes.rb
 - examples/query.rb
 - examples/query_with_consistency.rb
 - examples/search.rb
+- examples/search_with_consistency.rb
 - examples/subdocument.rb
+- examples/view.rb
 - ext/.clang-format
 - ext/.clang-tidy
 - ext/.cmake-format.yaml
@@ -138,6 +144,10 @@ files:
 - ext/couchbase/document_id.hxx
 - ext/couchbase/error_map.hxx
 - ext/couchbase/errors.hxx
+- ext/couchbase/io/dns_client.hxx
+- ext/couchbase/io/dns_codec.hxx
+- ext/couchbase/io/dns_config.hxx
+- ext/couchbase/io/dns_message.hxx
 - ext/couchbase/io/http_message.hxx
 - ext/couchbase/io/http_parser.hxx
 - ext/couchbase/io/http_session.hxx
@@ -147,6 +157,17 @@ files:
 - ext/couchbase/io/session_manager.hxx
 - ext/couchbase/mutation_token.hxx
 - ext/couchbase/operations.hxx
+- ext/couchbase/operations/analytics_dataset_create.hxx
+- ext/couchbase/operations/analytics_dataset_drop.hxx
+- ext/couchbase/operations/analytics_dataset_get_all.hxx
+- ext/couchbase/operations/analytics_dataverse_create.hxx
+- ext/couchbase/operations/analytics_dataverse_drop.hxx
+- ext/couchbase/operations/analytics_get_pending_mutations.hxx
+- ext/couchbase/operations/analytics_index_create.hxx
+- ext/couchbase/operations/analytics_index_drop.hxx
+- ext/couchbase/operations/analytics_index_get_all.hxx
+- ext/couchbase/operations/analytics_link_connect.hxx
+- ext/couchbase/operations/analytics_link_disconnect.hxx
 - ext/couchbase/operations/bucket_create.hxx
 - ext/couchbase/operations/bucket_drop.hxx
 - ext/couchbase/operations/bucket_flush.hxx
@@ -158,6 +179,8 @@ files:
 - ext/couchbase/operations/collection_create.hxx
 - ext/couchbase/operations/collection_drop.hxx
 - ext/couchbase/operations/command.hxx
+- ext/couchbase/operations/design_document.hxx
+- ext/couchbase/operations/document_analytics.hxx
 - ext/couchbase/operations/document_decrement.hxx
 - ext/couchbase/operations/document_exists.hxx
 - ext/couchbase/operations/document_get.hxx
@@ -175,6 +198,7 @@ files:
 - ext/couchbase/operations/document_touch.hxx
 - ext/couchbase/operations/document_unlock.hxx
 - ext/couchbase/operations/document_upsert.hxx
+- ext/couchbase/operations/document_view.hxx
 - ext/couchbase/operations/query_index_build_deferred.hxx
 - ext/couchbase/operations/query_index_create.hxx
 - ext/couchbase/operations/query_index_drop.hxx
@@ -192,6 +216,10 @@ files:
 - ext/couchbase/operations/search_index_get_all.hxx
 - ext/couchbase/operations/search_index_get_documents_count.hxx
 - ext/couchbase/operations/search_index_upsert.hxx
+- ext/couchbase/operations/view_index_drop.hxx
+- ext/couchbase/operations/view_index_get.hxx
+- ext/couchbase/operations/view_index_get_all.hxx
+- ext/couchbase/operations/view_index_upsert.hxx
 - ext/couchbase/platform/base64.cc
 - ext/couchbase/platform/base64.h
 - ext/couchbase/platform/random.cc
@@ -240,6 +268,7 @@ files:
 - ext/couchbase/service_type.hxx
 - ext/couchbase/timeout_defaults.hxx
 - ext/couchbase/utils/byteswap.hxx
+- ext/couchbase/utils/connection_string.hxx
 - ext/couchbase/utils/crc32.hxx
 - ext/couchbase/utils/url_codec.hxx
 - ext/couchbase/version.hxx
@@ -2133,6 +2162,7 @@ files:
 - ext/third_party/spdlog/tests/utils.cpp
 - ext/third_party/spdlog/tests/utils.h
 - lib/couchbase.rb
+- lib/couchbase/analytics_options.rb
 - lib/couchbase/authenticator.rb
 - lib/couchbase/binary_collection.rb
 - lib/couchbase/binary_collection_options.rb
@@ -2151,10 +2181,12 @@ files:
 - lib/couchbase/management/user_manager.rb
 - lib/couchbase/management/view_index_manager.rb
 - lib/couchbase/mutation_state.rb
+- lib/couchbase/query_options.rb
 - lib/couchbase/scope.rb
 - lib/couchbase/search_options.rb
 - lib/couchbase/subdoc.rb
 - lib/couchbase/version.rb
+- lib/couchbase/view_options.rb
 - rbi/couchbase.rbi
 homepage: https://www.couchbase.com
 licenses: