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

data/lib/couchbase/errors.rb

@@ -13,210 +13,212 @@
 #  limitations under the License.
 
 module Couchbase
-  # Common exceptions
+  module Error
+    # Common exceptions
 
-  class RequestCanceled < StandardError
-  end
+    class RequestCanceled < StandardError
+    end
 
-  class InvalidArgument < StandardError
-  end
+    class InvalidArgument < StandardError
+    end
 
-  class ServiceNotAvailable < StandardError
-  end
+    class ServiceNotAvailable < StandardError
+    end
 
-  class InternalServerFailure < StandardError
-  end
+    class InternalServerFailure < StandardError
+    end
 
-  class AuthenticationFailure < StandardError
-  end
+    class AuthenticationFailure < StandardError
+    end
 
-  class TemporaryFailure < StandardError
-  end
+    class TemporaryFailure < StandardError
+    end
 
-  class ParsingFailure < StandardError
-  end
+    class ParsingFailure < StandardError
+    end
 
-  class CasMismatch < StandardError
-  end
+    class CasMismatch < StandardError
+    end
 
-  class BucketNotFound < StandardError
-  end
+    class BucketNotFound < StandardError
+    end
 
-  class CollectionNotFound < StandardError
-  end
+    class CollectionNotFound < StandardError
+    end
 
-  class ScopeNotFound < StandardError
-  end
+    class ScopeNotFound < StandardError
+    end
 
-  class IndexNotFound < StandardError
-  end
+    class IndexNotFound < StandardError
+    end
 
-  class IndexExists < StandardError
-  end
+    class IndexExists < StandardError
+    end
 
-  class EncodingFailure < StandardError
-  end
+    class EncodingFailure < StandardError
+    end
 
-  class DecodingFailure < StandardError
-  end
+    class DecodingFailure < StandardError
+    end
 
-  class UnsupportedOperation < StandardError
-  end
+    class UnsupportedOperation < StandardError
+    end
 
-  class AmbiguousTimeout < StandardError
-  end
+    class AmbiguousTimeout < StandardError
+    end
 
-  class UnambiguousTimeout < StandardError
-  end
+    class UnambiguousTimeout < StandardError
+    end
 
-  class FeatureNotAvailable < StandardError
-  end
+    class FeatureNotAvailable < StandardError
+    end
 
-  # KeyValue exceptions
+    # KeyValue exceptions
 
-  class DocumentNotFound < StandardError
-  end
+    class DocumentNotFound < StandardError
+    end
 
-  class DocumentIrretrievable < StandardError
-  end
+    class DocumentIrretrievable < StandardError
+    end
 
-  class DocumentLocked < StandardError
-  end
+    class DocumentLocked < StandardError
+    end
 
-  class ValueTooLarge < StandardError
-  end
+    class ValueTooLarge < StandardError
+    end
 
-  class DocumentExists < StandardError
-  end
+    class DocumentExists < StandardError
+    end
 
-  class DurabilityLevelNotAvailable < StandardError
-  end
+    class DurabilityLevelNotAvailable < StandardError
+    end
 
-  class DurabilityImpossible < StandardError
-  end
+    class DurabilityImpossible < StandardError
+    end
 
-  class DurabilityAmbiguous < StandardError
-  end
+    class DurabilityAmbiguous < StandardError
+    end
 
-  class DurableWriteInProgress < StandardError
-  end
+    class DurableWriteInProgress < StandardError
+    end
 
-  class DurableWriteReCommitInProgress < StandardError
-  end
+    class DurableWriteReCommitInProgress < StandardError
+    end
 
-  class PathNotFound < StandardError
-  end
+    class PathNotFound < StandardError
+    end
 
-  class PathMismatch < StandardError
-  end
+    class PathMismatch < StandardError
+    end
 
-  class PathInvalid < StandardError
-  end
+    class PathInvalid < StandardError
+    end
 
-  class PathTooDeep < StandardError
-  end
+    class PathTooDeep < StandardError
+    end
 
-  class PathTooBig < StandardError
-  end
+    class PathTooBig < StandardError
+    end
 
-  class ValueTooDeep < StandardError
-  end
+    class ValueTooDeep < StandardError
+    end
 
-  class ValueInvalid < StandardError
-  end
+    class ValueInvalid < StandardError
+    end
 
-  class DocumentNotJson < StandardError
-  end
+    class DocumentNotJson < StandardError
+    end
 
-  class NumberTooBig < StandardError
-  end
+    class NumberTooBig < StandardError
+    end
 
-  class DeltaInvalid < StandardError
-  end
+    class DeltaInvalid < StandardError
+    end
 
-  class PathExists < StandardError
-  end
+    class PathExists < StandardError
+    end
 
-  class XattrUnknownMacro < StandardError
-  end
+    class XattrUnknownMacro < StandardError
+    end
 
-  class XattrInvalidKeyCombo < StandardError
-  end
+    class XattrInvalidKeyCombo < StandardError
+    end
 
-  class XattrUnknownVirtualAttribute < StandardError
-  end
+    class XattrUnknownVirtualAttribute < StandardError
+    end
 
-  class XattrCannotModifyVirtualAttribute < StandardError
-  end
+    class XattrCannotModifyVirtualAttribute < StandardError
+    end
 
-  # Query exceptions
+    # Query exceptions
 
-  class PlanningFailure < StandardError
-  end
+    class PlanningFailure < StandardError
+    end
 
-  class IndexFailure < StandardError
-  end
+    class IndexFailure < StandardError
+    end
 
-  class PreparedStatementFailure < StandardError
-  end
+    class PreparedStatementFailure < StandardError
+    end
 
 
-  # Analytics exceptions
+    # Analytics exceptions
 
-  class CompilationFailure < StandardError
-  end
+    class CompilationFailure < StandardError
+    end
 
-  class JobQueueFull < StandardError
-  end
+    class JobQueueFull < StandardError
+    end
 
-  class DatasetNotFound < StandardError
-  end
+    class DatasetNotFound < StandardError
+    end
 
-  class DatasetExists < StandardError
-  end
+    class DatasetExists < StandardError
+    end
 
-  class DataverseExists < StandardError
-  end
+    class DataverseExists < StandardError
+    end
 
-  class DataverseNotFound < StandardError
-  end
+    class DataverseNotFound < StandardError
+    end
 
-  class LinkNotFound < StandardError
-  end
+    class LinkNotFound < StandardError
+    end
 
-  # View exceptions
+    # View exceptions
 
-  class DesignDocumentNotFound < StandardError
-  end
+    class DesignDocumentNotFound < StandardError
+    end
 
-  class ViewNotFound < StandardError
-  end
+    class ViewNotFound < StandardError
+    end
 
-  # Management exceptions
+    # Management exceptions
 
-  class CollectionExists < StandardError
-  end
+    class CollectionExists < StandardError
+    end
 
-  class ScopeExists < StandardError
-  end
+    class ScopeExists < StandardError
+    end
 
-  class UserExists < StandardError
-  end
+    class UserExists < StandardError
+    end
 
-  class BucketExists < StandardError
-  end
+    class BucketExists < StandardError
+    end
 
-  class BucketNotFlushable < StandardError
-  end
+    class BucketNotFlushable < StandardError
+    end
 
-  class GroupNotFound < StandardError
-  end
+    class GroupNotFound < StandardError
+    end
 
-  class UserNotFound < StandardError
-  end
+    class UserNotFound < StandardError
+    end
 
-  # Library-specific exceptions
+    # Library-specific exceptions
 
-  class BackendError < StandardError
+    class BackendError < StandardError
+    end
   end
 end

data/lib/couchbase/json_transcoder.rb

@@ -0,0 +1,32 @@
+#    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 JsonTranscoder
+    # @param [Object] document
+    # @return [Array<String, Integer>] pair of encoded document and flags
+    def encode(document)
+      [JSON.generate(document), (0x02 << 24) | 0x06]
+    end
+
+    # @param [String] blob string of bytes, containing encoded representation of the document
+    # @param [Integer, :json] flags bit field, describing how the data encoded
+    # @return Object decoded document
+    def decode(blob, flags)
+      JSON.parse(blob)
+    end
+  end
+end

data/lib/couchbase/management/analytics_index_manager.rb

@@ -12,6 +12,8 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
+require "couchbase/errors"
+
 module Couchbase
   module Management
     class AnalyticsIndexManager
@@ -27,8 +29,8 @@ module Couchbase
       # @param [String] dataverse_name
       # @param [CreateDataverseOptions] options
       #
-      # @raise DataverseExists
-      # @raise ArgumentError
+      # @raise [ArgumentError]
+      # @raise [Error::DataverseExists]
       def create_dataverse(dataverse_name, options = CreateDataverseOptions.new) end
 
       # Drops a dataverse
@@ -36,34 +38,96 @@ module Couchbase
       # @param [String] dataverse_name name of the dataverse
       # @param [DropDataverseOptions] options
       #
-      # @raise DataverseNotFound
-      # @raise ArgumentError
+      # @raise [ArgumentError]
+      # @raise [Error::DataverseNotFound]
       def drop_dataverse(dataverse_name, options = DropDataverseOptions.new) end
 
       # Creates a new dataset
       #
       # @param [String] dataset_name name of dataset
       # @param [String] bucket_name name of the bucket
+      # @param [CreateDatasetOptions] options
       #
-      # @raise DatasetAlreadyExistsError
-      # @raise ArgumentError
+      # @raise [ArgumentError]
+      # @raise [Error::DatasetExists]
       def create_dataset(dataset_name, bucket_name, options = CreateDatasetOptions.new) end
 
+      # Drops a dataset
+      #
+      # @param [String] dataset_name name of the dataset
+      # @param [DropDataverseOptions] options
+      # 
+      # @raise [ArgumentError]
+      # @raise [Error::DatasetNotFound]
       def drop_dataset(dataset_name, options = DropDatasetOptions.new) end
 
-      def get_all_datasets(options = GetAllDatasetOptions.new) end
+      # Gets all datasets
+      #
+      # @param [GetAllDatasetsOptions] options
+      #
+      # @return [Array<AnalyticsDataset>]
+      def get_all_datasets(options = GetAllDatasetsOptions.new)
+        # SELECT d.* FROM Metadata.`Dataset` d WHERE d.DataverseName <> "Metadata"
+      end
 
+      # Creates a new index
+      #
+      # @param [String] index_name name of the index
+      # @param [String] dataset_name name of the dataset
+      # @param [Hash<String, String>] fields mapping of the field name to field type
+      # @param [CreateIndexOptions] options
+      #
+      # @raise [ArgumentError]
+      # @raise [Error::IndexExists]
       def create_index(index_name, dataset_name, fields, options = CreateIndexOptions.new) end
 
+      # Drops an index
+      #
+      # @param [String] index_name name of the index
+      # @param [String] dataset_name name of the dataset
+      # @param [DropIndexOptions] options
+      #
+      # @raise [ArgumentError]
+      # @raise [Error::IndexNotFound]
       def drop_index(index_name, dataset_name, options = DropIndexOptions.new) end
 
-      def get_all_indexes(options = GetAllIndexesOptions.new) end
+      # Gets all indexes
+      #
+      # @param [GetAllIndexesOptions] options
+      #
+      # @return [Array<AnalyticsIndex>]
+      def get_all_indexes(options = GetAllIndexesOptions.new)
+        # SELECT d.* FROM Metadata.`Index` d WHERE d.DataverseName <> "Metadata"
+      end
 
+      # Connects a link
+      #
+      # @param [ConnectLinkOptions] options
+      #
+      # @raise [ArgumentError]
+      # @raise [Error::LinkNotFound]
       def connect_link(options = ConnectLinkOptions.new) end
 
+      # Disconnects a link,
+      #
+      # @param [DisconnectLinkOptions] options
+      #
+      # @raise [ArgumentError]
+      # @raise [Error::LinkNotFound]
       def disconnect_link(options = DisconnectLinkOptions.new) end
 
-      def get_pending_mutations(options = GetPendingMutations.new) end
+      # Gets the pending mutations for all datasets.
+      # 
+      # @note If a link is disconnected then it will return no results. If all links are disconnected, then
+      # an empty object is returned.
+      #
+      # @param [GetPendingMutationsOptions] options
+      #
+      # @return [Hash<String, Integer>] dictionary, where keys are dataset coordinates encoded as +"dataverse.dataset"+
+      #   and values are number of mutations for given dataset.
+      def get_pending_mutations(options = GetPendingMutationsOptions.new)
+        # GET http://localhost:8095/analytics/node/agg/stats/remaining
+      end
 
       class CreateDataverseOptions
         # @return [Boolean] ignore if the dataverse already exists
@@ -110,6 +174,118 @@ module Couchbase
         end
       end
 
+      class DropDatasetOptions
+        # @return [Boolean] ignore if the dataset does not exists
+        attr_accessor :ignore_if_not_exists
+
+        # @return [String] The name of the dataverse to use (defaults to +nil+)
+        attr_accessor :dataverse_name
+
+        # @return [Integer] the time in milliseconds allowed for the operation to complete
+        attr_accessor :timeout
+
+        def initialize
+          @ignore_if_not_exists = false
+          yield self if block_given?
+        end
+      end
+
+      class GetAllDatasetsOptions
+        # @return [Integer] the time in milliseconds allowed for the operation to complete
+        attr_accessor :timeout
+
+        def initialize
+          @ignore_if_not_exists = false
+          yield self if block_given?
+        end
+      end
+
+      class CreateIndexOptions
+        # @return [Boolean] ignore if the index already exists
+        attr_accessor :ignore_if_exists
+
+        # @return [String] The name of the dataverse to use (defaults to +nil+)
+        attr_accessor :dataverse_name
+
+        # @return [Integer] the time in milliseconds allowed for the operation to complete
+        attr_accessor :timeout
+
+        def initialize
+          @ignore_if_exists = false
+          yield self if block_given?
+        end
+      end
+
+      class DropIndexOptions
+        # @return [Boolean] ignore if the index does not exists
+        attr_accessor :ignore_if_not_exists
+
+        # @return [String] The name of the dataverse to use (defaults to +nil+)
+        attr_accessor :dataverse_name
+
+        # @return [Integer] the time in milliseconds allowed for the operation to complete
+        attr_accessor :timeout
+
+        def initialize
+          @ignore_if_not_exists = false
+          yield self if block_given?
+        end
+      end
+
+      class GetAllIndexesOptions
+        # @return [Integer] the time in milliseconds allowed for the operation to complete
+        attr_accessor :timeout
+
+        def initialize
+          yield self if block_given?
+        end
+      end
+
+      class ConnectLinkOptions
+        # @return [String] The name of the link (defaults to +"Local"+)
+        attr_accessor :link_name
+
+        # @return [Boolean] Whether to force link creation even if the bucket UUID changed, for example due to the
+        # bucket being deleted and recreated (defaults to +false+)
+        attr_accessor :force
+
+        # @return [String] The name of the dataverse to use (defaults to +nil+)
+        attr_accessor :dataverse_name
+
+        # @return [Integer] the time in milliseconds allowed for the operation to complete
+        attr_accessor :timeout
+
+        def initialize
+          @link_name = "Local"
+          @force = false
+          yield self if block_given?
+        end
+      end
+
+      class DisconnectLinkOptions
+        # @return [String] The name of the link (defaults to +"Local"+)
+        attr_accessor :link_name
+
+        # @return [String] The name of the dataverse to use (defaults to +nil+)
+        attr_accessor :dataverse_name
+
+        # @return [Integer] the time in milliseconds allowed for the operation to complete
+        attr_accessor :timeout
+
+        def initialize
+          @link_name = "Local"
+          yield self if block_given?
+        end
+      end
+
+      class GetPendingMutationsOptions
+        # @return [Integer] the time in milliseconds allowed for the operation to complete
+        attr_accessor :timeout
+
+        def initialize
+          yield self if block_given?
+        end
+      end
     end
 
     class AnalyticsDataset