couchbase 3.0.0.alpha.1-universal-darwin-19 → 3.0.0.beta.1-universal-darwin-19

data/lib/couchbase/analytics_options.rb

@@ -0,0 +1,179 @@
+#    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 [Boolean] Allows explicitly marking a query as being readonly and not mutating any 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
+
+      # @api private
+      # @return [Hash<String => #to_json>]
+      attr_reader :raw_parameters
+
+      # @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
+
+      # @api private
+      # @return [Array<String>, nil]
+      def export_positional_parameters
+        @positional_parameters.map { |p| JSON.dump(p) } if @positional_parameters
+      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
+
+      # @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) } if @named_parameters
+      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/binary_collection.rb

@@ -12,6 +12,8 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
+require "couchbase/binary_collection_options"
+
 module Couchbase
   class BinaryCollection
     alias_method :inspect, :to_s
@@ -19,15 +21,16 @@ module Couchbase
     # @param [Couchbase::Collection] collection parent collection
     def initialize(collection)
       @collection = collection
+      @backend = collection.instance_variable_get("@backend")
     end
 
     # Appends binary content to the document
-    # 
+    #
     # @param [String] id the document id which is used to uniquely identify it
     # @param [String] content the binary content to append to the document
     # @param [AppendOptions] options custom options to customize the request
     #
-    # @return [MutationResult]
+    # @return [Collection::MutationResult]
     def append(id, content, options = AppendOptions.new) end
 
     # Prepends binary content to the document
@@ -36,93 +39,51 @@ module Couchbase
     # @param [String] content the binary content to prepend to the document
     # @param [PrependOptions] options custom options to customize the request
     #
-    # @return [MutationResult]
+    # @return [Collection::MutationResult]
     def prepend(id, content, options = PrependOptions.new) end
 
     # Increments the counter document by one of the number defined in the options
-    # 
+    #
     # @param [String] id the document id which is used to uniquely identify it
     # @param [IncrementOptions] options custom options to customize the request
     #
     # @return [CounterResult]
-    def increment(id, options = IncrementOptions.new) end
+    def increment(id, options = IncrementOptions.new)
+      resp = @backend.document_increment(@collection.bucket_name, "#{@collection.scope_name}.#{@collection.name}", id,
+                                         options.timeout,
+                                         {
+                                             delta: options.delta,
+                                             initial_value: options.initial,
+                                             expiry: options.expiry,
+                                             durability_level: options.durability_level,
+                                         })
+      CounterResult.new do |res|
+        res.cas = resp[:cas]
+        res.content = resp[:content]
+        res.mutation_token = @collection.send(:extract_mutation_token, resp)
+      end
+    end
 
     # Decrements the counter document by one of the number defined in the options
     #
     # @param [String] id the document id which is used to uniquely identify it
-    # @param [IncrementOptions] options custom options to customize the request
+    # @param [DecrementOptions] options custom options to customize the request
     #
     # @return [CounterResult]
-    def decrement(id, options = DecrementOptions.new) end
-
-    class AppendOptions < CommonOptions
-      # @return [Integer] The default CAS used (0 means no CAS in this context)
-      attr_accessor :cas
-
-      def initialize
-        yield self if block_given?
-      end
-    end
-
-    class PrependOptions < CommonOptions
-      # @return [Integer] The default CAS used (0 means no CAS in this context)
-      attr_accessor :cas
-
-      def initialize
-        yield self if block_given?
-      end
-    end
-
-    class IncrementOptions < CommonOptions
-      # @return [Integer] the delta for the operation
-      attr_reader :delta
-
-      # @return [Integer] if present, holds the initial value
-      attr_accessor :initial
-
-      # @return [Integer] if set, holds the expiration for the operation
-      attr_accessor :expiration
-
-      # @return [Integer] if set, holds the CAS value for this operation
-      attr_accessor :cas
-
-      def initialize
-        @delta = 1
-        yield self if block_given?
-      end
-
-      def delta=(value)
-        if delta < 0
-          raise ArgumentError, "the delta cannot be less than 0"
-        end
-        @delta = value
-      end
-    end
-
-    class DecrementOptions < CommonOptions
-      # @return [Integer] the delta for the operation
-      attr_reader :delta
-
-      # @return [Integer] if present, holds the initial value
-      attr_accessor :initial
-
-      # @return [Integer] if set, holds the expiration for the operation
-      attr_accessor :expiration
-
-      # @return [Integer] if set, holds the CAS value for this operation
-      attr_accessor :cas
-
-      def initialize
-        @delta = 1
-        yield self if block_given?
-      end
-
-      def delta=(value)
-        if delta < 0
-          raise ArgumentError, "the delta cannot be less than 0"
-        end
-        @delta = value
+    def decrement(id, options = DecrementOptions.new)
+      resp = @backend.document_decrement(@collection.bucket_name, "#{@collection.scope_name}.#{@collection.name}", id,
+                                         options.timeout,
+                                         {
+                                             delta: options.delta,
+                                             initial_value: options.initial,
+                                             expiry: options.expiry,
+                                             durability_level: options.durability_level,
+                                         })
+      CounterResult.new do |res|
+        res.cas = resp[:cas]
+        res.content = resp[:content]
+        res.mutation_token = @collection.send(:extract_mutation_token, resp)
       end
     end
   end
-end
+end

data/lib/couchbase/binary_collection_options.rb

@@ -0,0 +1,98 @@
+#    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/collection_options"
+
+module Couchbase
+  class BinaryCollection
+    class AppendOptions < CommonOptions
+      # @return [Integer] The default CAS used (0 means no CAS in this context)
+      attr_accessor :cas
+
+      # @yieldparam [AppendOptions] self
+      def initialize
+        yield self if block_given?
+      end
+    end
+
+    class PrependOptions < CommonOptions
+      # @return [Integer] The default CAS used (0 means no CAS in this context)
+      attr_accessor :cas
+
+      # @yieldparam [PrependOptions] self
+      def initialize
+        yield self if block_given?
+      end
+    end
+
+    class IncrementOptions < CommonOptions
+      # @return [Integer] the delta for the operation
+      attr_reader :delta
+
+      # @return [Integer] if present, holds the initial value
+      attr_accessor :initial
+
+      # @return [Integer] if set, holds the expiration for the operation
+      attr_accessor :expiry
+
+      # @return [:none, :majority, :majority_and_persist_to_active, :persist_to_majority] level of durability
+      attr_accessor :durability_level
+
+      # @yieldparam [IncrementOptions] self
+      def initialize
+        @delta = 1
+        yield self if block_given?
+      end
+
+      def delta=(value)
+        if delta < 0
+          raise ArgumentError, "the delta cannot be less than 0"
+        end
+        @delta = value
+      end
+    end
+
+    class DecrementOptions < CommonOptions
+      # @return [Integer] the delta for the operation
+      attr_reader :delta
+
+      # @return [Integer] if present, holds the initial value
+      attr_accessor :initial
+
+      # @return [Integer] if set, holds the expiration for the operation
+      attr_accessor :expiry
+
+      # @return [:none, :majority, :majority_and_persist_to_active, :persist_to_majority] level of durability
+      attr_accessor :durability_level
+
+      # @yieldparam [DecrementOptions] self
+      def initialize
+        @delta = 1
+        yield self if block_given?
+      end
+
+      def delta=(value)
+        if delta < 0
+          raise ArgumentError, "the delta cannot be less than 0"
+        end
+        @delta = value
+      end
+    end
+
+    class CounterResult < ::Couchbase::Collection::MutationResult
+      # @return [Integer] current value of the counter
+      attr_accessor :content
+    end
+  end
+end

data/lib/couchbase/bucket.rb

@@ -12,15 +12,21 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-require 'couchbase/scope'
+require "couchbase/scope"
+require "couchbase/management/collection_manager"
+require "couchbase/management/view_index_manager"
+require "couchbase/view_options"
 
 module Couchbase
   class Bucket
+    # @return [String] name of the bucket
+    attr_reader :name
+
     alias_method :inspect, :to_s
 
     # @param [Couchbase::Backend] backend
     def initialize(backend, name)
-      backend.open_bucket(name)
+      backend.open_bucket(name, true)
       @backend = backend
       @name = name
     end
@@ -29,7 +35,7 @@ module Couchbase
     #
     # @return [Scope]
     def default_scope
-      Scope.new(@backend, @name, :default)
+      Scope.new(@backend, @name, :_default)
     end
 
     # Get a named scope
@@ -54,7 +60,59 @@ module Couchbase
     #
     # @return [Collection]
     def default_collection
-      default_scope.default_collection
+      Collection.new(@backend, @name, :_default, :_default)
+    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 [ViewResult]
+    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) } if options.keys),
+          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
@@ -78,4 +136,4 @@ module Couchbase
       end
     end
   end
-end
+end