couchbase 3.1.1 → 3.2.0

data/lib/couchbase/options.rb

@@ -40,6 +40,13 @@ module Couchbase
         @parent_span = parent_span
         yield self if block_given?
       end
+
+      # @api private
+      def to_backend
+        {
+          timeout: @timeout.respond_to?(:in_milliseconds) ? @timeout.public_send(:in_milliseconds) : @timeout,
+        }
+      end
     end
 
     # Options for {Collection#get}
@@ -128,7 +135,7 @@ module Couchbase
       # @param [Hash, nil] client_context the client context data, if set
       # @param [Span, nil] parent_span if set holds the parent span, that should be used for this request
       #
-      # @yieldparam [Get] self
+      # @yieldparam [GetMulti] self
       def initialize(transcoder: JsonTranscoder.new,
                      timeout: nil,
                      retry_strategy: nil,
@@ -1142,13 +1149,53 @@ module Couchbase
     class Cluster
       attr_accessor :authenticator # @return [PasswordAuthenticator, CertificateAuthenticator]
 
+      attr_accessor :enable_metrics # @return [Boolean]
+      attr_accessor :metrics_emit_interval # @return [nil, Integer, #in_milliseconds]
+      attr_accessor :enable_tracing # @return [Boolean]
+      attr_accessor :orphaned_emit_interval # @return [nil, Integer, #in_milliseconds]
+      attr_accessor :orphaned_sample_size # @return [nil, Integer]
+      attr_accessor :threshold_emit_interval # @return [nil, Integer, #in_milliseconds]
+      attr_accessor :threshold_sample_size # @return [nil, Integer]
+      attr_accessor :key_value_threshold # @return [nil, Integer, #in_milliseconds]
+      attr_accessor :query_threshold # @return [nil, Integer, #in_milliseconds]
+      attr_accessor :view_threshold # @return [nil, Integer, #in_milliseconds]
+      attr_accessor :search_threshold # @return [nil, Integer, #in_milliseconds]
+      attr_accessor :analytics_threshold # @return [nil, Integer, #in_milliseconds]
+      attr_accessor :management_threshold # @return [nil, Integer, #in_milliseconds]
+
       # Creates an instance of options for {Couchbase::Cluster.connect}
       #
       # @param [PasswordAuthenticator, CertificateAuthenticator] authenticator
       #
       # @yieldparam [Cluster] self
-      def initialize(authenticator: nil)
+      def initialize(authenticator: nil,
+                     enable_metrics: nil,
+                     metrics_emit_interval: nil,
+                     enable_tracing: nil,
+                     orphaned_emit_interval: nil,
+                     orphaned_sample_size: nil,
+                     threshold_emit_interval: nil,
+                     threshold_sample_size: nil,
+                     key_value_threshold: nil,
+                     query_threshold: nil,
+                     view_threshold: nil,
+                     search_threshold: nil,
+                     analytics_threshold: nil,
+                     management_threshold: nil)
         @authenticator = authenticator
+        @enable_metrics = enable_metrics
+        @metrics_emit_interval = metrics_emit_interval
+        @enable_tracing = enable_tracing
+        @orphaned_emit_interval = orphaned_emit_interval
+        @orphaned_sample_size = orphaned_sample_size
+        @threshold_emit_interval = threshold_emit_interval
+        @threshold_sample_size = threshold_sample_size
+        @key_value_threshold = key_value_threshold
+        @query_threshold = query_threshold
+        @view_threshold = view_threshold
+        @search_threshold = search_threshold
+        @analytics_threshold = analytics_threshold
+        @management_threshold = management_threshold
         yield self if block_given?
       end
 
@@ -1157,6 +1204,25 @@ module Couchbase
       def authenticate(username, password)
         @authenticator = PasswordAuthenticator.new(username, password)
       end
+
+      # @api private
+      def to_backend
+        {
+          enable_metrics: @enable_metrics,
+          metrics_emit_interval: Utils::Time.extract_duration(@metrics_emit_interval),
+          enable_tracing: @enable_tracing,
+          orphaned_emit_interval: Utils::Time.extract_duration(@orphaned_emit_interval),
+          orphaned_sample_size: @orphaned_sample_size,
+          threshold_emit_interval: Utils::Time.extract_duration(@threshold_emit_interval),
+          threshold_sample_size: @threshold_sample_size,
+          key_value_threshold: Utils::Time.extract_duration(@key_value_threshold),
+          query_threshold: Utils::Time.extract_duration(@query_threshold),
+          view_threshold: Utils::Time.extract_duration(@view_threshold),
+          search_threshold: Utils::Time.extract_duration(@search_threshold),
+          analytics_threshold: Utils::Time.extract_duration(@analytics_threshold),
+          management_threshold: Utils::Time.extract_duration(@management_threshold),
+        }
+      end
     end
 
     # Options for {Couchbase::Cluster#diagnostics}
@@ -1563,6 +1629,7 @@ module Couchbase
       attr_accessor :highlight_fields # @return [Array<String>]
       attr_accessor :fields # @return [Array<String>]
       attr_accessor :disable_scoring # @return [Boolean]
+      attr_accessor :collections # @return [Array<String>, nil]
       attr_accessor :sort # @return [Array<String, Cluster::SearchSort>]
       attr_accessor :facets # @return [Hash<String => Cluster::SearchFacet>]
       attr_accessor :transcoder # @return [JsonTranscoder, #decode(String)]
@@ -1578,6 +1645,7 @@ module Couchbase
       #   were stored while indexing
       # @param [MutationState] mutation_state the mutation tokens this query should be consistent with
       # @param [Boolean] disable_scoring If set to true, the server will not perform any scoring on the hits
+      # @param [Array<String>, nil] collections list of collections by which to filter the results
       # @param [Array<String, Cluster::SearchSort>] sort Ordering rules to apply to the results. The list might contain
       #   either strings or special objects, that derive from {Cluster::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
@@ -1601,6 +1669,7 @@ module Couchbase
                      fields: nil,
                      mutation_state: nil,
                      disable_scoring: false,
+                     collections: nil,
                      sort: nil,
                      facets: nil,
                      transcoder: JsonTranscoder.new,
@@ -1616,6 +1685,7 @@ module Couchbase
         @highlight_fields = highlight_fields
         @fields = fields
         @disable_scoring = disable_scoring
+        @collections = collections
         @sort = sort
         @facets = facets
         @transcoder = transcoder
@@ -1658,13 +1728,15 @@ module Couchbase
       attr_reader :scan_consistency
 
       # @api private
-      def to_backend
+      def to_backend(scope_name: nil)
         {
           timeout: @timeout.respond_to?(:in_milliseconds) ? @timeout.public_send(:in_milliseconds) : @timeout,
           limit: @limit,
           skip: @skip,
           explain: @explain,
           disable_scoring: @disable_scoring,
+          scope: scope_name,
+          collections: scope_name ? @collections : nil,
           highlight_style: @highlight_style,
           highlight_fields: @highlight_fields,
           fields: @fields,

data/lib/couchbase/scope.rb

@@ -124,5 +124,107 @@ module Couchbase
         res.instance_variable_set("@rows", resp[:rows])
       end
     end
+
+    # Performs a Full Text Search (FTS) query
+    #
+    # @param [String] index_name the name of the search index
+    # @param [SearchQuery] query the query tree
+    # @param [Options::Search] options the query tree
+    #
+    # @example Return first 10 results of "hop beer" query and request highlighting
+    #   cluster.search_query("travel_index", Cluster::SearchQuery.match_phrase("green"),
+    #                        Options::Search(
+    #                          limit: 10,
+    #                          collections: ["landmark", "hotel"]
+    #                          fields: %w[name],
+    #                          highlight_style: :html,
+    #                          highlight_fields: %w[name description]
+    #                        ))
+    #
+    # @return [SearchResult]
+    def search_query(index_name, query, options = Options::Search.new)
+      resp = @backend.document_search(index_name, JSON.generate(query), options.to_backend(scope_name: @name))
+
+      SearchResult.new do |res|
+        res.meta_data = SearchMetaData.new do |meta|
+          meta.metrics.max_score = resp[:meta_data][:metrics][:max_score]
+          meta.metrics.error_partition_count = resp[:meta_data][:metrics][:error_partition_count]
+          meta.metrics.success_partition_count = resp[:meta_data][:metrics][:success_partition_count]
+          meta.metrics.took = resp[:meta_data][:metrics][:took]
+          meta.metrics.total_rows = resp[:meta_data][:metrics][:total_rows]
+          meta.errors = resp[:meta_data][:errors]
+        end
+        res.rows = resp[:rows].map do |r|
+          SearchRow.new do |row|
+            row.transcoder = options.transcoder
+            row.index = r[:index]
+            row.id = r[:id]
+            row.score = r[:score]
+            row.fragments = r[:fragments]
+            row.locations = SearchRowLocations.new(
+              r[:locations].map do |loc|
+                SearchRowLocation.new do |location|
+                  location.field = loc[:field]
+                  location.term = loc[:term]
+                  location.position = loc[:position]
+                  location.start_offset = loc[:start_offset]
+                  location.end_offset = loc[:end_offset]
+                  location.array_positions = loc[:array_positions]
+                end
+              end
+            )
+            row.instance_variable_set("@fields", r[:fields])
+            row.explanation = JSON.parse(r[:explanation]) if r[:explanation]
+          end
+        end
+        if resp[:facets]
+          res.facets = resp[:facets].each_with_object({}) do |(k, v), o|
+            facet = case options.facets[k]
+                    when SearchFacet::SearchFacetTerm
+                      SearchFacetResult::TermFacetResult.new do |f|
+                        f.terms =
+                          if v[:terms]
+                            v[:terms].map do |t|
+                              SearchFacetResult::TermFacetResult::TermFacet.new(t[:term], t[:count])
+                            end
+                          else
+                            []
+                          end
+                      end
+                    when SearchFacet::SearchFacetDateRange
+                      SearchFacetResult::DateRangeFacetResult.new do |f|
+                        f.date_ranges =
+                          if v[:date_ranges]
+                            v[:date_ranges].map do |r|
+                              SearchFacetResult::DateRangeFacetResult::DateRangeFacet.new(r[:name], r[:count], r[:start_time], r[:end_time])
+                            end
+                          else
+                            []
+                          end
+                      end
+                    when SearchFacet::SearchFacetNumericRange
+                      SearchFacetResult::NumericRangeFacetResult.new do |f|
+                        f.numeric_ranges =
+                          if v[:numeric_ranges]
+                            v[:numeric_ranges].map do |r|
+                              SearchFacetResult::NumericRangeFacetResult::NumericRangeFacet.new(r[:name], r[:count], r[:min], r[:max])
+                            end
+                          else
+                            []
+                          end
+                      end
+                    else
+                      next # ignore unknown facet result
+                    end
+            facet.name = v[:name]
+            facet.field = v[:field]
+            facet.total = v[:total]
+            facet.missing = v[:missing]
+            facet.other = v[:other]
+            o[k] = facet
+          end
+        end
+      end
+    end
   end
 end

data/lib/couchbase/utils/time.rb

@@ -47,6 +47,10 @@ module Couchbase
           time_or_duration
         end
       end
+
+      def extract_duration(number_or_duration)
+        number_or_duration.respond_to?(:in_milliseconds) ? number_or_duration.public_send(:in_milliseconds) : number_or_duration
+      end
     end
   end
 end

data/lib/couchbase/version.rb

@@ -17,15 +17,15 @@ module Couchbase
   #
   # @example Display version and all dependencies in command line
   #   # ruby -rcouchbase -e 'pp Couchbase::VERSION'
-  #   {:sdk=>"3.1.0",
-  #    :backend=>"1.4.0",
-  #    :build_timestamp=>"2021-03-24 11:25:34",
-  #    :revision=>"7ba4f7d8b5b0b59b9971ad765876413be3064adb",
+  #   {:sdk=>"3.1.1",
+  #    :backend=>"1.5.0",
+  #    :build_timestamp=>"2021-04-08 16:29:43",
+  #    :revision=>"a79d098eb238b3883e49e1738c35167642e8834f",
   #    :platform=>"Linux-4.15.0-66-generic",
   #    :cpu=>"x86_64",
   #    :cc=>"GNU 9.3.1",
   #    :cxx=>"GNU 9.3.1",
-  #    :ruby=>"3.0.0",
+  #    :ruby=>"2.7.0",
   #    :spdlog=>"1.8.1",
   #    :asio=>"1.18.0",
   #    :snappy=>"1.1.8",
@@ -33,5 +33,5 @@ module Couchbase
   #    :openssl_headers=>"OpenSSL 1.1.1g FIPS  21 Apr 2020",
   #    :openssl_runtime=>"OpenSSL 1.1.1g FIPS  21 Apr 2020"}
   VERSION = {} unless defined?(VERSION) # rubocop:disable Style/MutableConstant
-  VERSION.update(:sdk => "3.1.1".freeze)
+  VERSION.update(:sdk => "3.2.0".freeze)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: couchbase
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Sergey Avseyev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-08 00:00:00.000000000 Z
+date: 2021-08-03 00:00:00.000000000 Z
 dependencies: []
 description: Modern SDK for Couchbase Server
 email:
@@ -89,6 +89,10 @@ files:
 - ext/couchbase/io/retry_reason.hxx
 - ext/couchbase/io/retry_strategy.hxx
 - ext/couchbase/io/streams.hxx
+- ext/couchbase/metrics/logging_meter.hxx
+- ext/couchbase/metrics/logging_meter_options.hxx
+- ext/couchbase/metrics/meter.hxx
+- ext/couchbase/metrics/noop_meter.hxx
 - ext/couchbase/mutation_token.hxx
 - ext/couchbase/operations.hxx
 - ext/couchbase/operations/analytics_dataset_create.hxx
@@ -100,8 +104,16 @@ files:
 - 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.hxx
+- ext/couchbase/operations/analytics_link_azure_blob_external.hxx
 - ext/couchbase/operations/analytics_link_connect.hxx
+- ext/couchbase/operations/analytics_link_couchbase_remote.hxx
+- ext/couchbase/operations/analytics_link_create.hxx
 - ext/couchbase/operations/analytics_link_disconnect.hxx
+- ext/couchbase/operations/analytics_link_drop.hxx
+- ext/couchbase/operations/analytics_link_get_all.hxx
+- ext/couchbase/operations/analytics_link_replace.hxx
+- ext/couchbase/operations/analytics_link_s3_external.hxx
 - ext/couchbase/operations/bucket_create.hxx
 - ext/couchbase/operations/bucket_drop.hxx
 - ext/couchbase/operations/bucket_flush.hxx
@@ -226,9 +238,15 @@ files:
 - ext/couchbase/protocol/unsigned_leb128.h
 - ext/couchbase/service_type.hxx
 - ext/couchbase/timeout_defaults.hxx
+- ext/couchbase/tracing/constants.hxx
+- ext/couchbase/tracing/noop_tracer.hxx
+- ext/couchbase/tracing/request_tracer.hxx
+- ext/couchbase/tracing/threshold_logging_options.hxx
+- ext/couchbase/tracing/threshold_logging_tracer.hxx
 - ext/couchbase/utils/byteswap.hxx
 - ext/couchbase/utils/connection_string.hxx
 - ext/couchbase/utils/crc32.hxx
+- ext/couchbase/utils/name_codec.hxx
 - ext/couchbase/utils/url_codec.hxx
 - ext/couchbase/version.hxx
 - ext/extconf.rb
@@ -239,6 +257,7 @@ files:
 - ext/test/test_native_binary_operations.cxx
 - ext/test/test_native_diagnostics.cxx
 - ext/test/test_native_trivial_crud.cxx
+- ext/test/test_native_trivial_query.cxx
 - ext/test/test_ruby_trivial_crud.cxx
 - ext/test/test_ruby_trivial_query.cxx
 - ext/third_party/asio/asio/include/asio.hpp
@@ -813,6 +832,30 @@ files:
 - ext/third_party/gsl/include/gsl/span
 - ext/third_party/gsl/include/gsl/span_ext
 - ext/third_party/gsl/include/gsl/string_span
+- ext/third_party/hdr_histogram_c/CMakeLists.txt
+- ext/third_party/hdr_histogram_c/COPYING.txt
+- ext/third_party/hdr_histogram_c/LICENSE.txt
+- ext/third_party/hdr_histogram_c/config.cmake.in
+- ext/third_party/hdr_histogram_c/src/CMakeLists.txt
+- ext/third_party/hdr_histogram_c/src/hdr_atomic.h
+- ext/third_party/hdr_histogram_c/src/hdr_encoding.c
+- ext/third_party/hdr_histogram_c/src/hdr_encoding.h
+- ext/third_party/hdr_histogram_c/src/hdr_endian.h
+- ext/third_party/hdr_histogram_c/src/hdr_histogram.c
+- ext/third_party/hdr_histogram_c/src/hdr_histogram.h
+- ext/third_party/hdr_histogram_c/src/hdr_histogram_log.c
+- ext/third_party/hdr_histogram_c/src/hdr_histogram_log.h
+- ext/third_party/hdr_histogram_c/src/hdr_histogram_log_no_op.c
+- ext/third_party/hdr_histogram_c/src/hdr_interval_recorder.c
+- ext/third_party/hdr_histogram_c/src/hdr_interval_recorder.h
+- ext/third_party/hdr_histogram_c/src/hdr_malloc.h
+- ext/third_party/hdr_histogram_c/src/hdr_tests.h
+- ext/third_party/hdr_histogram_c/src/hdr_thread.c
+- ext/third_party/hdr_histogram_c/src/hdr_thread.h
+- ext/third_party/hdr_histogram_c/src/hdr_time.c
+- ext/third_party/hdr_histogram_c/src/hdr_time.h
+- ext/third_party/hdr_histogram_c/src/hdr_writer_reader_phaser.c
+- ext/third_party/hdr_histogram_c/src/hdr_writer_reader_phaser.h
 - ext/third_party/http_parser/LICENSE-MIT
 - ext/third_party/http_parser/http_parser.c
 - ext/third_party/http_parser/http_parser.h
@@ -1375,9 +1418,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.1.1
-  changelog_uri: https://github.com/couchbase/couchbase-ruby-client/releases/tag/3.1.1
-  documentation_uri: https://docs.couchbase.com/sdk-api/couchbase-ruby-client-3.1.1/index.html
+  source_code_uri: https://github.com/couchbase/couchbase-ruby-client/tree/3.2.0
+  changelog_uri: https://github.com/couchbase/couchbase-ruby-client/releases/tag/3.2.0
+  documentation_uri: https://docs.couchbase.com/sdk-api/couchbase-ruby-client-3.2.0/index.html
   github_repo: ssh://github.com/couchbase/couchbase-ruby-client
 post_install_message: 
 rdoc_options:
@@ -1389,14 +1432,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: SDK for Couchbase Server