couchbase 3.0.1 → 3.0.2

data/lib/couchbase/query_options.rb

@@ -12,153 +12,10 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-require 'json'
+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 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.
-      #
-      # @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
-
-      # Tells the query engine to use a flex index (utilizing the search service)
-      #
-      # @api uncommitted
-      # @return [Boolean]
-      attr_accessor :flex_index
-
-      # 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
-
-      # @api private
-      # @return [MutationState]
-      attr_reader :mutation_state
-
-      # @api private
-      # @return [Hash<String => #to_json>]
-      attr_reader :raw_parameters
-
-      # @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
-        @scope_qualifier = nil
-        @flex_index = false
-        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
-
-      # @api private
-      # @return [Array<String>, nil]
-      def export_positional_parameters
-        @positional_parameters&.map { |p| JSON.dump(p) }
-      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
-
-      # @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) }
-      end
-    end
-
     class QueryResult
       # @return [QueryMetaData] returns object representing additional metadata associated with this query
       attr_accessor :meta_data

data/lib/couchbase/scope.rb

@@ -44,36 +44,19 @@ module Couchbase
     #
     # The query will be implicitly scoped using current bucket and scope names.
     #
-    # @see QueryOptions#scope_qualifier
+    # @see Options::Query#scope_qualifier
     # @see Cluster#query
     #
     # @param [String] statement the N1QL query statement
-    # @param [QueryOptions] options the custom options for this query
+    # @param [Options::Query] options the custom options for this query
+    #
+    # @example Select first ten hotels from travel sample dataset
+    #   cluster.query("SELECT * FROM `travel-sample` WHERE type = $type LIMIT 10",
+    #                 Options::Query(named_parameters: {type: "hotel"}, metrics: true))
     #
     # @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,
-        flex_index: options.flex_index,
-        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,
-      })
+    def query(statement, options = Options::Query.new)
+      resp = @backend.document_query(statement, options.to_backend(scope_name: @name, bucket_name: @bucket_name))
 
       Cluster::QueryResult.new do |res|
         res.meta_data = Cluster::QueryMetaData.new do |meta|

data/lib/couchbase/search_options.rb

@@ -1206,99 +1206,6 @@ module Couchbase
       end
     end
 
-    class SearchOptions
-      # @return [Integer] Timeout in milliseconds
-      attr_accessor :timeout
-
-      # @return [Integer] limits the number of matches returned from the complete result set.
-      attr_accessor :limit
-
-      # @return [Integer] indicates how many matches are skipped on the result set before starting to return the matches
-      attr_accessor :skip
-
-      # @return [Boolean] triggers inclusion of additional search result score explanations. (Default: +false+)
-      attr_accessor :explain
-
-      # @return [:html, :ansi] the style of highlighting in the result excerpts (if not specified, the server default will be used)
-      attr_accessor :highlight_style
-
-      # @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
-      attr_accessor :fields
-
-      # @return [:not_bounded] specifies level of consistency for the query
-      attr_reader :scan_consistency
-
-      # @api private
-      # @return [MutationState]
-      attr_reader :mutation_state
-
-      # @api uncommitted
-      # If set to true, the server will not perform any scoring on the hits
-      # @return [Boolean]
-      attr_accessor :disable_scoring
-
-      # Customizes the consistency guarantees for this query
-      #
-      # @note overrides consistency level set by {#consistent_with}
-      #
-      # [+:not_bounded+] The engine will return whatever state it has at the time of query
-      #
-      # @param [:not_bounded] level the scan consistency to be used for this query
-      #
-      # @return [void]
-      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
-      #
-      # @return [void]
-      def consistent_with(mutation_state)
-        @scan_consistency = nil if @scan_consistency
-        @mutation_state = mutation_state
-      end
-
-      # Ordering rules to apply to the results
-      #
-      # 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.
-      #
-      # When nothing specified, the Server will order results by their score descending, which is equivalent of +"-_score"+.
-      #
-      # @return [Array<String, SearchSort>] list of ordering object
-      attr_accessor :sort
-
-      # Facets allow to aggregate information collected on a particular result set
-      #
-      # @return [Hash<String => SearchFacet>]
-      attr_accessor :facets
-
-      # @return [JsonTranscoder] transcoder to use for the results
-      attr_accessor :transcoder
-
-      # @yieldparam [SearchOptions] self
-      def initialize
-        super
-        @disable_scoring = false
-        @explain = false
-        @transcoder = JsonTranscoder.new
-        @scan_consistency = nil
-        @mutation_state = nil
-        yield self if block_given?
-      end
-    end
-
     class SearchRowLocation
       # @return [String]
       attr_accessor :field

data/lib/couchbase/version.rb

@@ -13,6 +13,25 @@
 #  limitations under the License.
 
 module Couchbase
+  # Version of the library and all bundled dependencies
+  #
+  # @example Display version and all dependencies in command line
+  #   # ruby -rcouchbase -e 'pp Couchbase::VERSION'
+  #   {:sdk=>"3.0.1",
+  #    :backend=>"1.1.0",
+  #    :build_timestamp=>"2020-10-05 11:19:50",
+  #    :revision=>"b59cb40f11ec2dba992eda285eae5cd7238a59c3",
+  #    :platform=>"Linux-4.15.0-66-generic",
+  #    :cpu=>"x86_64",
+  #    :cc=>"GNU 9.3.1",
+  #    :cxx=>"GNU 9.3.1",
+  #    :ruby=>"2.7.0",
+  #    :spdlog=>"1.8.1",
+  #    :asio=>"1.18.0",
+  #    :snappy=>"1.1.8",
+  #    :http_parser=>"2.9.4",
+  #    :openssl_headers=>"OpenSSL 1.1.1c FIPS  28 May 2019",
+  #    :openssl_runtime=>"OpenSSL 1.1.1c FIPS  28 May 2019"}
   VERSION = {} unless defined?(VERSION) # rubocop:disable Style/MutableConstant
-  VERSION.update(:sdk => "3.0.1".freeze)
+  VERSION.update(:sdk => "3.0.2".freeze)
 end

data/lib/couchbase/view_options.rb

@@ -12,100 +12,10 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-require 'json'
+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 [ViewOptions] 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: couchbase
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Sergey Avseyev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-05 00:00:00.000000000 Z
+date: 2020-11-03 00:00:00.000000000 Z
 dependencies: []
 description: Modern SDK for Couchbase Server
 email:
@@ -72,6 +72,7 @@ files:
 - ext/couchbase/io/http_session.hxx
 - ext/couchbase/io/http_session_manager.hxx
 - ext/couchbase/io/mcbp_command.hxx
+- ext/couchbase/io/mcbp_context.hxx
 - ext/couchbase/io/mcbp_message.hxx
 - ext/couchbase/io/mcbp_parser.hxx
 - ext/couchbase/io/mcbp_session.hxx
@@ -108,6 +109,7 @@ files:
 - ext/couchbase/operations/collections_manifest_get.hxx
 - ext/couchbase/operations/design_document.hxx
 - ext/couchbase/operations/document_analytics.hxx
+- ext/couchbase/operations/document_append.hxx
 - ext/couchbase/operations/document_decrement.hxx
 - ext/couchbase/operations/document_exists.hxx
 - ext/couchbase/operations/document_get.hxx
@@ -118,6 +120,7 @@ files:
 - ext/couchbase/operations/document_insert.hxx
 - ext/couchbase/operations/document_lookup_in.hxx
 - ext/couchbase/operations/document_mutate_in.hxx
+- ext/couchbase/operations/document_prepend.hxx
 - ext/couchbase/operations/document_query.hxx
 - ext/couchbase/operations/document_remove.hxx
 - ext/couchbase/operations/document_replace.hxx
@@ -130,6 +133,8 @@ files:
 - ext/couchbase/operations/group_get.hxx
 - ext/couchbase/operations/group_get_all.hxx
 - ext/couchbase/operations/group_upsert.hxx
+- ext/couchbase/operations/http_noop.hxx
+- ext/couchbase/operations/mcbp_noop.hxx
 - ext/couchbase/operations/query_index_build_deferred.hxx
 - ext/couchbase/operations/query_index_create.hxx
 - ext/couchbase/operations/query_index_drop.hxx
@@ -175,6 +180,7 @@ files:
 - ext/couchbase/protocol/client_opcode.hxx
 - ext/couchbase/protocol/client_request.hxx
 - ext/couchbase/protocol/client_response.hxx
+- ext/couchbase/protocol/cmd_append.hxx
 - ext/couchbase/protocol/cmd_cluster_map_change_notification.hxx
 - ext/couchbase/protocol/cmd_decrement.hxx
 - ext/couchbase/protocol/cmd_exists.hxx
@@ -191,6 +197,8 @@ files:
 - ext/couchbase/protocol/cmd_insert.hxx
 - ext/couchbase/protocol/cmd_lookup_in.hxx
 - ext/couchbase/protocol/cmd_mutate_in.hxx
+- ext/couchbase/protocol/cmd_noop.hxx
+- ext/couchbase/protocol/cmd_prepend.hxx
 - ext/couchbase/protocol/cmd_remove.hxx
 - ext/couchbase/protocol/cmd_replace.hxx
 - ext/couchbase/protocol/cmd_sasl_auth.hxx
@@ -217,9 +225,11 @@ files:
 - ext/couchbase/utils/url_codec.hxx
 - ext/couchbase/version.hxx
 - ext/extconf.rb
+- ext/test/CMakeLists.txt
 - ext/test/test_helper.hxx
 - ext/test/test_helper_native.hxx
 - ext/test/test_helper_ruby.hxx
+- ext/test/test_native_binary_operations.cxx
 - ext/test/test_native_diagnostics.cxx
 - ext/test/test_native_trivial_crud.cxx
 - ext/test/test_ruby_trivial_crud.cxx
@@ -1320,14 +1330,15 @@ files:
 - lib/couchbase/cluster.rb
 - lib/couchbase/collection.rb
 - lib/couchbase/collection_options.rb
-- lib/couchbase/common_options.rb
 - lib/couchbase/datastructures.rb
 - lib/couchbase/datastructures/couchbase_list.rb
 - lib/couchbase/datastructures/couchbase_map.rb
 - lib/couchbase/datastructures/couchbase_queue.rb
 - lib/couchbase/datastructures/couchbase_set.rb
+- lib/couchbase/diagnostics.rb
 - lib/couchbase/errors.rb
 - lib/couchbase/json_transcoder.rb
+- lib/couchbase/logger.rb
 - lib/couchbase/management/analytics_index_manager.rb
 - lib/couchbase/management/bucket_manager.rb
 - lib/couchbase/management/collection_manager.rb
@@ -1336,6 +1347,7 @@ files:
 - lib/couchbase/management/user_manager.rb
 - lib/couchbase/management/view_index_manager.rb
 - lib/couchbase/mutation_state.rb
+- lib/couchbase/options.rb
 - lib/couchbase/query_options.rb
 - lib/couchbase/scope.rb
 - lib/couchbase/search_options.rb
@@ -1349,9 +1361,9 @@ metadata:
   homepage_uri: https://docs.couchbase.com/ruby-sdk/3.0/hello-world/start-using-sdk.html
   bug_tracker_uri: https://couchbase.com/issues/browse/RCBC
   mailing_list_uri: https://forums.couchbase.com/c/ruby-sdk
-  source_code_uri: https://github.com/couchbase/couchbase-ruby-client/tree/3.0.1
-  changelog_uri: https://github.com/couchbase/couchbase-ruby-client/releases/tag/3.0.1
-  documentation_uri: https://docs.couchbase.com/sdk-api/couchbase-ruby-client-3.0.1/index.html
+  source_code_uri: https://github.com/couchbase/couchbase-ruby-client/tree/3.0.2
+  changelog_uri: https://github.com/couchbase/couchbase-ruby-client/releases/tag/3.0.2
+  documentation_uri: https://docs.couchbase.com/sdk-api/couchbase-ruby-client-3.0.2/index.html
   github_repo: ssh://github.com/couchbase/couchbase-ruby-client
 post_install_message: 
 rdoc_options:
@@ -1370,7 +1382,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: SDK for Couchbase Server