couchbase 3.4.0-arm64-darwin-20 → 3.4.1-arm64-darwin-20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a2277769a3018bb5da68ff42d71fd07a5c58bf5ddf909a44df354b1de15e3b8
-  data.tar.gz: cdbd1ea416416a893e98d8f407e7758bbad151d7f74ba5ff63e7cf43ddc27fe0
+  metadata.gz: 0c66775f9944c58be71025321c4cd11d33068f47e723ebc3f1116172d4d1b0c2
+  data.tar.gz: e8cf7b5a11ac1ca879c34d89f1bc063e67e8cfd9ed8de5a435316aea9e488a74
 SHA512:
-  metadata.gz: 3180001d391d32cbe4fd6a2ccb0c11c6f716e1a89ee52995d7deba670e1f7da7607a1b25199c499a7950fae2cb96cb9a278ae0884b182bf45f67310d92ce29ec
-  data.tar.gz: 12411839477ef27153db8de7a97e1fb81cb88259e5e0a9964b2ea510b65c47110eaa20f44d07013c0353f74ec258f385114eefcc1a6d6b33a13c688d067caaab
+  metadata.gz: 49a1c6a75d971fb8a79128dfea4212425b8f5c9cb1304c12e34c23dd8587b957826146829ecb031afaabce5b82f0a79e14f9127ffa02e5be5433dde469d662d4
+  data.tar.gz: 491c19def9f8fbc4e124064150766c3c7be643d8f628d68eea9f4b702586ef6fc61e87820e3418635b245554f28078e9c455b2b472270e7eb415f617ce0e4157

data/README.md

@@ -23,7 +23,7 @@ The library has been tested with MRI 3.0, 3.1 and 3.2. Supported platforms are L
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "couchbase", "3.4.0"
+gem "couchbase", "3.4.1"
 ```
 
 And then execute:

data/lib/couchbase/binary_collection.rb

@@ -38,7 +38,7 @@ module Couchbase
     #   collection.get("mydoc", Options::Get(transcoder: nil)).content #=> "foobar"
     #
     # @return [Collection::MutationResult]
-    def append(id, content, options = Options::Append.new)
+    def append(id, content, options = Options::Append::DEFAULT)
       resp = @backend.document_append(@collection.bucket_name, @collection.scope_name, @collection.name,
                                       id, content, options.to_backend)
       Collection::MutationResult.new do |res|
@@ -59,7 +59,7 @@ module Couchbase
     #   collection.get("mydoc", Options::Get(transcoder: nil)).content #=> "barfoo"
     #
     # @return [Collection::MutationResult]
-    def prepend(id, content, options = Options::Prepend.new)
+    def prepend(id, content, options = Options::Prepend::DEFAULT)
       resp = @backend.document_prepend(@collection.bucket_name, @collection.scope_name, @collection.name,
                                        id, content, options.to_backend)
       Collection::MutationResult.new do |res|
@@ -80,7 +80,7 @@ module Couchbase
     #   res.content #=> 10
     #
     # @return [CounterResult]
-    def increment(id, options = Options::Increment.new)
+    def increment(id, options = Options::Increment::DEFAULT)
       resp = @backend.document_increment(@collection.bucket_name, @collection.scope_name, @collection.name, id,
                                          options.to_backend)
       CounterResult.new do |res|
@@ -102,7 +102,7 @@ module Couchbase
     #   res.value #=> 98
     #
     # @return [CounterResult]
-    def decrement(id, options = Options::Decrement.new)
+    def decrement(id, options = Options::Decrement::DEFAULT)
       resp = @backend.document_decrement(@collection.bucket_name, @collection.scope_name, @collection.name, id,
                                          options.to_backend)
       CounterResult.new do |res|

data/lib/couchbase/collection.rb

@@ -43,6 +43,11 @@ module Couchbase
       BinaryCollection.new(self)
     end
 
+    # @return [Management::CollectionQueryIndexManager]
+    def query_indexes
+      Management::CollectionQueryIndexManager.new(@backend, @bucket_name, @scope_name, @name)
+    end
+
     # Fetches the full document from the collection
     #
     # @param [String] id the document id which is used to uniquely identify it

data/lib/couchbase/errors.rb

@@ -21,6 +21,11 @@ module Couchbase
       # @return [Hash] attributes associated with the error
       attr_reader :context
 
+      def initialize(msg = nil, context = nil)
+        @context = context unless context.nil?
+        super(msg)
+      end
+
       def to_s
         defined?(@context) ? "#{super}, context=#{JSON.generate(@context)}" : super
       end
@@ -30,6 +35,11 @@ module Couchbase
       # @return [Hash] attributes associated with the error
       attr_reader :context
 
+      def initialize(msg = nil, context = nil)
+        @context = context unless context.nil?
+        super(msg)
+      end
+
       def to_s
         defined?(@context) ? "#{super}, context=#{JSON.generate(@context)}" : super
       end

data/lib/couchbase/management/collection_query_index_manager.rb

@@ -0,0 +1,183 @@
+#  Copyright 2023 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/management/query_index_manager"
+require "couchbase/utils/time"
+
+module Couchbase
+  module Management
+    class CollectionQueryIndexManager
+      alias inspect to_s
+
+      # @param [Couchbase::Backend] backend
+      # @param [String] bucket_name name of the bucket
+      # @param [String] scope_name name of the scope
+      # @param [String] collection_name name of the collection
+      def initialize(backend, bucket_name, scope_name, collection_name)
+        @backend = backend
+        @bucket_name = bucket_name
+        @scope_name = scope_name
+        @collection_name = collection_name
+      end
+
+      # Fetches all indexes from the server
+      #
+      # @param [Options::Query::GetAllIndexes] options
+      #
+      # @return [Array<QueryIndex>]
+      #
+      # @raise [ArgumentError]
+      def get_all_indexes(options = Options::Query::GetAllIndexes.new)
+        res = @backend.collection_query_index_get_all(@bucket_name, @scope_name, @collection_name, options.to_backend)
+        res[:indexes].map do |idx|
+          QueryIndex.new do |index|
+            index.name = idx[:name]
+            index.is_primary = idx[:is_primary]
+            index.type = idx[:type]
+            index.state = idx[:state]
+            index.bucket = idx[:bucket_name]
+            index.scope = idx[:scope_name]
+            index.collection = idx[:collection_name]
+            index.index_key = idx[:index_key]
+            index.condition = idx[:condition]
+            index.partition = idx[:partition]
+          end
+        end
+      end
+
+      # Creates a new index
+      #
+      # @param [String] index_name name of the index
+      # @param [Array<String>] fields the lists of fields to create th index over
+      # @param [Options::Query::CreateIndex] options
+      #
+      # @return void
+      #
+      # @raise [ArgumentError]
+      # @raise [Error::IndexExists]
+      def create_index(index_name, fields, options = Options::Query::CreateIndex.new)
+        unless options.scope_name.nil?
+          raise ArgumentError, "Scope name cannot be set in the options when using the Query Index manager at the collection level"
+        end
+
+        unless options.collection_name.nil?
+          raise ArgumentError, "Collection name cannot be set in the options when using the Query Index manager at the collection level"
+        end
+
+        @backend.collection_query_index_create(@bucket_name, @scope_name, @collection_name, index_name, fields, options.to_backend)
+      end
+
+      # Creates new primary index
+      #
+      # @param [Options::Query::CreatePrimaryIndex] options
+      #
+      # @return void
+      #
+      # @raise [ArgumentError]
+      # @raise [Error::IndexExists]
+      def create_primary_index(options = Options::Query::CreatePrimaryIndex.new)
+        unless options.scope_name.nil?
+          raise ArgumentError, "Scope name cannot be set in the options when using the Query Index manager at the collection level"
+        end
+
+        unless options.collection_name.nil?
+          raise ArgumentError, "Collection name cannot be set in the options when using the Query Index manager at the collection level"
+        end
+
+        @backend.collection_query_index_create_primary(@bucket_name, @scope_name, @collection_name, options.to_backend)
+      end
+
+      # Drops the index
+      #
+      # @param [String] index_name name of the index
+      # @param [Options::Query::DropIndex] options
+      #
+      # @return void
+      #
+      # @raise [ArgumentError]
+      # @raise [Error::IndexNotFound]
+      def drop_index(index_name, options = Options::Query::DropIndex.new)
+        unless options.scope_name.nil?
+          raise ArgumentError, "Scope name cannot be set in the options when using the Query Index manager at the collection level"
+        end
+
+        unless options.collection_name.nil?
+          raise ArgumentError, "Collection name cannot be set in the options when using the Query Index manager at the collection level"
+        end
+
+        @backend.collection_query_index_drop(@bucket_name, @scope_name, @collection_name, index_name, options.to_backend)
+      end
+
+      # Drops the primary index
+      #
+      # @param [Options::Query::DropPrimaryIndex] options
+      #
+      # @return void
+      #
+      # @raise [ArgumentError]
+      # @raise [Error::IndexNotFound]
+      def drop_primary_index(options = Options::Query::DropPrimaryIndex.new)
+        unless options.scope_name.nil?
+          raise ArgumentError, "Scope name cannot be set in the options when using the Query Index manager at the collection level"
+        end
+
+        unless options.collection_name.nil?
+          raise ArgumentError, "Collection name cannot be set in the options when using the Query Index manager at the collection level"
+        end
+
+        @backend.collection_query_index_drop_primary(@bucket_name, @scope_name, @collection_name, options.to_backend)
+      end
+
+      # Build all indexes which are currently in deferred state
+      #
+      # @param [Options::Query::BuildDeferredIndexes] options
+      #
+      # @return void
+      #
+      # @raise [ArgumentError]
+      def build_deferred_indexes(options = Options::Query::BuildDeferredIndexes.new)
+        @backend.collection_query_index_build_deferred(@bucket_name, @scope_name, @collection_name, options.to_backend)
+      end
+
+      # Polls indexes until they are online
+      #
+      # @param [Array<String>] index_names names of the indexes to watch
+      # @param [Integer, #in_milliseconds] timeout the time in milliseconds allowed for the operation to complete
+      # @param [Options::Query::WatchIndexes] options
+      #
+      # @raise [ArgumentError]
+      # @raise [Error::IndexNotFound]
+      def watch_indexes(index_names, timeout, options = Options::Query::WatchIndexes.new)
+        index_names.append("#primary") if options.watch_primary
+
+        interval_millis = 50
+        deadline = Time.now + (Utils::Time.extract_duration(timeout) * 0.001)
+        while Time.now <= deadline
+          get_all_opts = Options::Query::GetAllIndexes.new(timeout: ((deadline - Time.now) * 1000).round)
+          indexes = get_all_indexes(get_all_opts).select { |idx| index_names.include? idx.name }
+          indexes_not_found = index_names - indexes.map(&:name)
+          raise Error::IndexNotFound, "Failed to find the indexes: #{indexes_not_found.join(', ')}" unless indexes_not_found.empty?
+
+          all_online = indexes.all? { |idx| idx.state == :online }
+          return if all_online
+
+          sleep(interval_millis / 1000)
+          interval_millis += 500
+          interval_millis = 1000 if interval_millis > 1000
+        end
+        raise Error::UnambiguousTimeout, "Failed to find all indexes online within the allotted time"
+      end
+    end
+  end
+end

data/lib/couchbase/management/query_index_manager.rb

@@ -14,6 +14,7 @@
 
 require "couchbase/errors"
 require "couchbase/options"
+require "couchbase/utils/time"
 
 module Couchbase
   module Management
@@ -371,6 +372,10 @@ module Couchbase
       # @raise [ArgumentError]
       # @raise [Error::IndexExists]
       def create_index(bucket_name, index_name, fields, options = Options::Query::CreateIndex.new)
+        unless options.scope_name.nil? && options.collection_name.nil?
+          warn "The attributes 'scope_name' and 'collection_name' have been deprecated. Use 'collection.query_indexes' instead"
+        end
+
         @backend.query_index_create(bucket_name, index_name, fields, options.to_backend)
       end
 
@@ -384,6 +389,10 @@ module Couchbase
       # @raise [ArgumentError]
       # @raise [Error::IndexExists]
       def create_primary_index(bucket_name, options = Options::Query::CreatePrimaryIndex.new)
+        unless options.scope_name.nil? && options.collection_name.nil?
+          warn "The attributes 'scope_name' and 'collection_name' have been deprecated. Use 'collection.query_indexes' instead"
+        end
+
         @backend.query_index_create_primary(bucket_name, options.to_backend)
       end
 
@@ -398,8 +407,11 @@ module Couchbase
       # @raise [ArgumentError]
       # @raise [Error::IndexNotFound]
       def drop_index(bucket_name, index_name, options = Options::Query::DropIndex.new)
+        unless options.scope_name.nil? && options.collection_name.nil?
+          warn "The attributes 'scope_name' and 'collection_name' have been deprecated. Use 'collection.query_indexes' instead"
+        end
+
         @backend.query_index_drop(bucket_name, index_name, options.to_backend)
-        true
       end
 
       # Drops the primary index
@@ -412,8 +424,11 @@ module Couchbase
       # @raise [ArgumentError]
       # @raise [Error::IndexNotFound]
       def drop_primary_index(bucket_name, options = Options::Query::DropPrimaryIndex.new)
+        unless options.scope_name.nil? && options.collection_name.nil?
+          warn "The attributes 'scope_name' and 'collection_name' have been deprecated. Use 'collection.query_indexes' instead"
+        end
+
         @backend.query_index_drop_primary(bucket_name, options.to_backend)
-        true
       end
 
       # Build all indexes which are currently in deferred state
@@ -438,7 +453,24 @@ module Couchbase
       # @raise [ArgumentError]
       # @raise [Error::IndexNotFound]
       def watch_indexes(bucket_name, index_names, timeout, options = Options::Query::WatchIndexes.new)
-        @backend.query_index_watch(bucket_name, index_names, Utils::Time.extract_duration(timeout), options.to_backend)
+        index_names.append("#primary") if options.watch_primary
+
+        interval_millis = 50
+        deadline = Time.now + (Utils::Time.extract_duration(timeout) * 0.001)
+        while Time.now <= deadline
+          get_all_opts = Options::Query::GetAllIndexes.new(timeout: ((deadline - Time.now) * 1000).round)
+          indexes = get_all_indexes(bucket_name, get_all_opts).select { |idx| index_names.include? idx.name }
+          indexes_not_found = index_names - indexes.map(&:name)
+          raise Error::IndexNotFound, "Failed to find the indexes: #{indexes_not_found.join(', ')}" unless indexes_not_found.empty?
+
+          all_online = indexes.all? { |idx| idx.state == :online }
+          return if all_online
+
+          sleep(interval_millis / 1000)
+          interval_millis += 500
+          interval_millis = 1000 if interval_millis > 1000
+        end
+        raise Error::UnambiguousTimeout, "Failed to find all indexes online within the allotted time"
       end
 
       # @api private

data/lib/couchbase/management.rb

@@ -22,6 +22,7 @@ require "couchbase/management/analytics_index_manager"
 require "couchbase/management/bucket_manager"
 require "couchbase/management/collection_manager"
 require "couchbase/management/query_index_manager"
+require "couchbase/management/collection_query_index_manager"
 require "couchbase/management/search_index_manager"
 require "couchbase/management/user_manager"
 require "couchbase/management/view_index_manager"

data/lib/couchbase/options.rb

@@ -2091,7 +2091,7 @@ module Couchbase
       attr_reader :scan_consistency
 
       # @api private
-      def to_backend(scope_name: nil)
+      def to_backend(*)
         {
           timeout: Utils::Time.extract_duration(@timeout),
           limit: @limit,
@@ -2099,8 +2099,7 @@ module Couchbase
           explain: @explain,
           disable_scoring: @disable_scoring,
           include_locations: @include_locations,
-          scope: scope_name,
-          collections: scope_name ? @collections : nil,
+          collections: @collections,
           highlight_style: @highlight_style,
           highlight_fields: @highlight_fields,
           fields: @fields,

data/lib/couchbase/version.rb

@@ -19,5 +19,5 @@ module Couchbase
   #   $ ruby -rcouchbase -e 'pp Couchbase::VERSION'
   #   {:sdk=>"3.4.0", :ruby_abi=>"3.1.0", :revision=>"416fe68e6029ec8a4c40611cf6e6b30d3b90d20f"}
   VERSION = {} unless defined?(VERSION) # rubocop:disable Style/MutableConstant
-  VERSION.update(:sdk => "3.4.0".freeze)
+  VERSION.update(:sdk => "3.4.1".freeze)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: couchbase
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.4.1
 platform: arm64-darwin-20
 authors:
 - Sergey Avseyev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-19 00:00:00.000000000 Z
+date: 2023-03-20 00:00:00.000000000 Z
 dependencies: []
 description: Modern SDK for Couchbase Server
 email:
@@ -47,6 +47,7 @@ files:
 - lib/couchbase/management/analytics_index_manager.rb
 - lib/couchbase/management/bucket_manager.rb
 - lib/couchbase/management/collection_manager.rb
+- lib/couchbase/management/collection_query_index_manager.rb
 - lib/couchbase/management/query_index_manager.rb
 - lib/couchbase/management/search_index_manager.rb
 - lib/couchbase/management/user_manager.rb
@@ -72,9 +73,9 @@ metadata:
   homepage_uri: https://docs.couchbase.com/ruby-sdk/current/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.4.0
-  changelog_uri: https://github.com/couchbase/couchbase-ruby-client/releases/tag/3.4.0
-  documentation_uri: https://docs.couchbase.com/sdk-api/couchbase-ruby-client-3.4.0/index.html
+  source_code_uri: https://github.com/couchbase/couchbase-ruby-client/tree/3.4.1
+  changelog_uri: https://github.com/couchbase/couchbase-ruby-client/releases/tag/3.4.1
+  documentation_uri: https://docs.couchbase.com/sdk-api/couchbase-ruby-client-3.4.1/index.html
   github_repo: ssh://github.com/couchbase/couchbase-ruby-client
   rubygems_mfa_required: 'true'
 post_install_message: