couchbase 3.0.0.alpha.2 → 3.0.0

data/lib/couchbase/management/bucket_manager.rb

@@ -17,7 +17,7 @@ require "couchbase/errors"
 module Couchbase
   module Management
     class BucketManager
-      alias_method :inspect, :to_s
+      alias inspect to_s
 
       # @param [Couchbase::Backend] backend
       def initialize(backend)
@@ -29,10 +29,14 @@ module Couchbase
       # @param [BucketSettings] settings bucket settings
       # @param [CreateBucketOptions] options
       #
+      # @return void
+      #
       # @raise [ArgumentError]
       # @raise [Error::BucketExists]
       def create_bucket(settings, options = CreateBucketOptions.new)
         @backend.bucket_create(
+          {
+
             name: settings.name,
             flush_enabled: settings.flush_enabled,
             ram_quota_mb: settings.ram_quota_mb,
@@ -43,6 +47,7 @@ module Couchbase
             max_expiry: settings.max_expiry,
             compression_mode: settings.compression_mode,
             conflict_resolution_type: settings.conflict_resolution_type,
+          }, options.timeout
         )
       end
 
@@ -51,10 +56,13 @@ module Couchbase
       # @param [BucketSettings] settings bucket settings
       # @param [UpdateBucketOptions] options
       #
+      # @return void
+      #
       # @raise [ArgumentError]
       # @raise [Error::BucketNotFound]
       def update_bucket(settings, options = UpdateBucketOptions.new)
         @backend.bucket_update(
+          {
             name: settings.name,
             flush_enabled: settings.flush_enabled,
             ram_quota_mb: settings.ram_quota_mb,
@@ -64,6 +72,7 @@ module Couchbase
             ejection_policy: settings.ejection_policy,
             max_expiry: settings.max_expiry,
             compression_mode: settings.compression_mode,
+          }, options.timeout
         )
       end
 
@@ -72,10 +81,12 @@ module Couchbase
       # @param [String] bucket_name name of the bucket
       # @param [DropBucketOptions] options
       #
+      # @return void
+      #
       # @raise [ArgumentError]
       # @raise [Error::BucketNotFound]
       def drop_bucket(bucket_name, options = DropBucketOptions.new)
-        @backend.bucket_drop(bucket_name)
+        @backend.bucket_drop(bucket_name, options.timeout)
       end
 
       # Fetch settings of the bucket
@@ -88,7 +99,7 @@ module Couchbase
       # @raise [ArgumentError]
       # @raise [Error::BucketNotFound]
       def get_bucket(bucket_name, options = GetBucketOptions.new)
-        res = @backend.bucket_get(bucket_name)
+        res = @backend.bucket_get(bucket_name, options.timeout)
         extract_bucket_settings(res)
       end
 
@@ -97,16 +108,19 @@ module Couchbase
       # @param [GetAllBucketsOptions] options
       # @return [Array<BucketSettings>]
       def get_all_buckets(options = GetAllBucketsOptions.new)
-        res = @backend.bucket_get_all
+        res = @backend.bucket_get_all(options.timeout)
         res.map(&method(:extract_bucket_settings))
       end
 
       # @param [String] bucket_name name of the bucket
+      #
+      # @return void
+      #
       # @raise [ArgumentError]
       # @raise [Error::BucketNotFound]
       # @raise [Error::BucketNotFlushable]
       def flush_bucket(bucket_name, options = FlushBucketOptions.new)
-        @backend.bucket_flush(bucket_name)
+        @backend.bucket_flush(bucket_name, options.timeout)
       end
 
       class CreateBucketOptions

data/lib/couchbase/management/collection_manager.rb

@@ -17,7 +17,7 @@ require "couchbase/errors"
 module Couchbase
   module Management
     class CollectionManager
-      alias_method :inspect, :to_s
+      alias inspect to_s
 
       # @param [Couchbase::Backend] backend
       # @param [String] bucket_name
@@ -32,7 +32,7 @@ module Couchbase
       #
       # @return [Array<ScopeSpec>]
       def get_all_scopes(options = GetAllScopesOptions.new)
-        res = @backend.scope_get_all(@bucket_name)
+        res = @backend.scope_get_all(@bucket_name, options.timeout)
         res[:scopes].map do |s|
           ScopeSpec.new do |scope|
             scope.name = s[:name]
@@ -55,7 +55,8 @@ module Couchbase
       #
       # @raise [Error::ScopeNotFound]
       def get_scope(scope_name, options = GetScopeOptions.new)
-        get_all_scopes.find { |scope| scope.name == scope_name } or raise Error::ScopeNotFound, "unable to find scope #{scope_name}"
+        get_all_scopes(GetAllScopesOptions.new { |o| o.timeout = options.timeout })
+          .find { |scope| scope.name == scope_name } or raise Error::ScopeNotFound, "unable to find scope #{scope_name}"
       end
 
       # Creates a new scope
@@ -63,9 +64,11 @@ module Couchbase
       # @param [String] scope_name name of the scope
       # @param [CreateScopeOptions] options
       #
+      # @return void
+      #
       # @raise [ArgumentError]
       def create_scope(scope_name, options = CreateScopeOptions.new)
-        @backend.scope_create(@bucket_name, scope_name)
+        @backend.scope_create(@bucket_name, scope_name, options.timeout)
       end
 
       # Removes a scope
@@ -73,9 +76,11 @@ module Couchbase
       # @param [String] scope_name name of the scope
       # @param [DropScopeOptions] options
       #
+      # @return void
+      #
       # @raise [Error::ScopeNotFound]
       def drop_scope(scope_name, options = DropScopeOptions.new)
-        @backend.scope_drop(@bucket_name, scope_name)
+        @backend.scope_drop(@bucket_name, scope_name, options.timeout)
       end
 
       # Creates a new collection
@@ -83,11 +88,13 @@ module Couchbase
       # @param [CollectionSpec] collection specification of the collection
       # @param [CreateCollectionOptions] options
       #
+      # @return void
+      #
       # @raise [ArgumentError]
       # @raise [Error::CollectionExist]
       # @raise [Error::ScopeNotFound]
       def create_collection(collection, options = CreateCollectionOptions.new)
-        @backend.collection_create(@bucket_name, collection.scope_name, collection.name, collection.max_expiry)
+        @backend.collection_create(@bucket_name, collection.scope_name, collection.name, collection.max_expiry, options.timeout)
       end
 
       # Removes a collection
@@ -95,9 +102,11 @@ module Couchbase
       # @param [CollectionSpec] collection specification of the collection
       # @param [DropCollectionOptions] options
       #
+      # @return void
+      #
       # @raise [Error::CollectionNotFound]
       def drop_collection(collection, options = DropCollectionOptions.new)
-        @backend.collection_drop(@bucket_name, collection.scope_name, collection.name)
+        @backend.collection_drop(@bucket_name, collection.scope_name, collection.name, options.timeout)
       end
 
       class GetScopeOptions

data/lib/couchbase/management/query_index_manager.rb

@@ -17,7 +17,7 @@ require "couchbase/errors"
 module Couchbase
   module Management
     class QueryIndexManager
-      alias_method :inspect, :to_s
+      alias inspect to_s
 
       # @param [Couchbase::Backend] backend
       def initialize(backend)
@@ -33,13 +33,16 @@ module Couchbase
       #
       # @raise [ArgumentError]
       def get_all_indexes(bucket_name, options = GetAllIndexOptions.new)
-        res = @backend.query_index_get_all(bucket_name)
+        res = @backend.query_index_get_all(bucket_name, options.timeout)
         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_id]
+            index.collection = idx[:collection_id]
+            index.scope = idx[:scope_id]
             index.key_space = idx[:keyspace_id]
             index.name_space = idx[:namespace_id]
             index.index_key = idx[:index_key]
@@ -55,15 +58,19 @@ module Couchbase
       # @param [Array<String>] fields the lists of fields to create th index over
       # @param [CreateIndexOptions] options
       #
+      # @return void
+      #
       # @raise [ArgumentError]
       # @raise [Error::IndexExists]
       def create_index(bucket_name, index_name, fields, options = CreateIndexOptions.new)
         @backend.query_index_create(bucket_name, index_name, fields, {
-            ignore_if_exists: options.ignore_if_exists,
-            condition: options.condition,
-            deferred: options.deferred,
-            num_replicas: options.num_replicas,
-        })
+          ignore_if_exists: options.ignore_if_exists,
+          condition: options.condition,
+          deferred: options.deferred,
+          num_replicas: options.num_replicas,
+          scope_name: options.scope_name,
+          collection_name: options.collection_name,
+        }, options.timeout)
       end
 
       # Creates new primary index
@@ -71,14 +78,18 @@ module Couchbase
       # @param [String] bucket_name name of the bucket
       # @param [CreatePrimaryIndexOptions] options
       #
+      # @return void
+      #
       # @raise [ArgumentError]
       # @raise [Error::IndexExists]
       def create_primary_index(bucket_name, options = CreatePrimaryIndexOptions.new)
         @backend.query_index_create_primary(bucket_name, {
-            ignore_if_exists: options.ignore_if_exists,
-            deferred: options.deferred,
-            num_replicas: options.num_replicas,
-        })
+          ignore_if_exists: options.ignore_if_exists,
+          deferred: options.deferred,
+          num_replicas: options.num_replicas,
+          scope_name: options.scope_name,
+          collection_name: options.collection_name,
+        }, options.timeout)
       end
 
       # Drops the index
@@ -87,12 +98,16 @@ module Couchbase
       # @param [String] index_name name of the index
       # @param [DropIndexOptions] options
       #
+      # @return void
+      #
       # @raise [ArgumentError]
       # @raise [Error::IndexNotFound]
       def drop_index(bucket_name, index_name, options = DropIndexOptions.new)
         @backend.query_index_drop(bucket_name, index_name, {
-            ignore_if_does_not_exist: options.ignore_if_does_not_exist,
-        })
+          ignore_if_does_not_exist: options.ignore_if_does_not_exist,
+          scope_name: options.scope_name,
+          collection_name: options.collection_name,
+        }, options.timeout)
         true
       end
 
@@ -101,13 +116,17 @@ module Couchbase
       # @param [String] bucket_name name of the bucket
       # @param [DropPrimaryIndexOptions] options
       #
+      # @return void
+      #
       # @raise [ArgumentError]
       # @raise [Error::IndexNotFound]
       def drop_primary_index(bucket_name, options = DropPrimaryIndexOptions.new)
         @backend.query_index_drop_primary(bucket_name, {
-            ignore_if_does_not_exist: options.ignore_if_does_not_exist,
-            index_name: options.index_name,
-        })
+          ignore_if_does_not_exist: options.ignore_if_does_not_exist,
+          index_name: options.index_name,
+          scope_name: options.scope_name,
+          collection_name: options.collection_name,
+        }, options.timeout)
         true
       end
 
@@ -116,9 +135,11 @@ module Couchbase
       # @param [String] bucket_name name of the bucket
       # @param [BuildDeferredIndexOptions] options
       #
+      # @return void
+      #
       # @raise [ArgumentError]
       def build_deferred_indexes(bucket_name, options = BuildDeferredIndexOptions.new)
-        @backend.query_index_build_deferred(bucket_name, {})
+        @backend.query_index_build_deferred(bucket_name, options.timeout)
       end
 
       # Polls indexes until they are online
@@ -131,7 +152,9 @@ module Couchbase
       # @raise [ArgumentError]
       # @raise [Error::IndexNotFound]
       def watch_indexes(bucket_name, index_names, timeout, options = WatchIndexesOptions.new)
-        @backend.query_index_watch(bucket_name, index_names, timeout, {})
+        @backend.query_index_watch(bucket_name, index_names, timeout, {
+          watch_primary: options.watch_primary,
+        })
       end
 
       class GetAllIndexOptions
@@ -160,6 +183,12 @@ module Couchbase
         # @return [String] condition to apply to the index
         attr_accessor :condition
 
+        # @return [String] the name of the scope
+        attr_accessor :scope_name
+
+        # @return [String] the name of the collection
+        attr_accessor :collection_name
+
         # @yieldparam [CreateIndexOptions] self
         def initialize
           @ignore_if_exists = false
@@ -183,6 +212,12 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @return [String] the name of the scope
+        attr_accessor :scope_name
+
+        # @return [String] the name of the collection
+        attr_accessor :collection_name
+
         # @yieldparam [CreatePrimaryIndexOptions] self
         def initialize
           @ignore_if_exists = false
@@ -197,6 +232,12 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @return [String] the name of the scope
+        attr_accessor :scope_name
+
+        # @return [String] the name of the collection
+        attr_accessor :collection_name
+
         # @yieldparam [DropIndexOptions] self
         def initialize
           @ignore_if_does_not_exist = false
@@ -214,6 +255,12 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @return [String] the name of the scope
+        attr_accessor :scope_name
+
+        # @return [String] the name of the collection
+        attr_accessor :collection_name
+
         # @yieldparam [DropPrimaryIndexOptions] self
         def initialize
           @ignore_if_does_not_exist = false
@@ -248,7 +295,7 @@ module Couchbase
 
       # @return [Boolean] true if this is a primary index
       attr_accessor :is_primary
-      alias_method :primary?, :is_primary
+      alias primary? is_primary
 
       # @return [:gsi, :view] type of the index
       attr_accessor :type
@@ -256,6 +303,15 @@ module Couchbase
       # @return [Symbol] state
       attr_accessor :state
 
+      # @return [String, nil] the name of the bucket
+      attr_accessor :bucket
+
+      # @return [String, nil] the name of the scope
+      attr_accessor :scope
+
+      # @return [String, nil] the name of the collection
+      attr_accessor :collection
+
       # @return [String] the key space for the index, typically the bucket name.
       attr_accessor :key_space
 
@@ -269,7 +325,6 @@ module Couchbase
       #   instance, it will show the indexed fields in an escaped format (surrounded by backticks).
       attr_accessor :index_key
 
-
       # @return [String] the string representation of the index's condition (the WHERE clause of the index),
       #   or an empty Optional if no condition was set.
       #

data/lib/couchbase/management/search_index_manager.rb

@@ -17,7 +17,7 @@ require "couchbase/errors"
 module Couchbase
   module Management
     class SearchIndexManager
-      alias_method :inspect, :to_s
+      alias inspect to_s
 
       # @param [Couchbase::Backend] backend
       def initialize(backend)
@@ -34,7 +34,8 @@ module Couchbase
       # @raise [ArgumentError]
       # @raise [Error::IndexNotFound]
       def get_index(index_name, options = GetIndexOptions.new)
-        # GET /api/index/{name}
+        res = @backend.search_index_get(index_name, options.timeout)
+        extract_search_index(res)
       end
 
       # Fetches all indexes from the server
@@ -43,7 +44,8 @@ module Couchbase
       #
       # @return [Array<SearchIndex>]
       def get_all_indexes(options = GetAllIndexesOptions.new)
-        # GET /api/index
+        res = @backend.search_index_get_all(options.timeout)
+        res[:indexes].map { |idx| extract_search_index(idx) }
       end
 
       # Creates or updates the index
@@ -51,9 +53,23 @@ module Couchbase
       # @param [SearchIndex] index_definition the index definition
       # @param [UpsertIndexOptions] options
       #
+      # @return void
+      #
       # @raise [ArgumentError] if name, type or source_type is empty
       def upsert_index(index_definition, options = UpsertIndexOptions.new)
-        # PUT /api/index/{index_name} "cache-control: no-cache"
+        @backend.search_index_upsert(
+          {
+            name: index_definition.name,
+            type: index_definition.type,
+            uuid: index_definition.uuid,
+            params: (JSON.generate(index_definition.params) if index_definition.params),
+            source_name: index_definition.source_name,
+            source_type: index_definition.source_type,
+            source_uuid: index_definition.source_uuid,
+            source_params: (JSON.generate(index_definition.source_params) if index_definition.source_params),
+            plan_params: (JSON.generate(index_definition.plan_params) if index_definition.plan_params),
+          }, options.timeout
+        )
       end
 
       # Drops the index
@@ -61,23 +77,26 @@ module Couchbase
       # @param [String] index_name name of the index
       # @param [DropIndexOptions] options
       #
+      # @return void
+      #
       # @raise [ArgumentError]
       # @raise [Error::IndexNotFound]
       def drop_index(index_name, options = DropIndexOptions.new)
-        # DELETE /api/index/{index_name}
+        @backend.search_index_drop(index_name, options.timeout)
       end
 
       # Retrieves the number of documents that have been indexed for an index
       #
       # @param [String] index_name name of the index
-      # @param [GetIndexedDocumentsOptions] options
+      # @param [GetIndexedDocumentsCountOptions] options
       #
       # @return [Integer]
       #
       # @raise [ArgumentError]
       # @raise [Error::IndexNotFound]
       def get_indexed_documents_count(index_name, options = GetIndexedDocumentsCountOptions.new)
-        # GET /api/index/{index_name}/count
+        res = @backend.search_index_get_documents_count(index_name, options.timeout)
+        res[:count]
       end
 
       # Pauses updates and maintenance for the index
@@ -85,10 +104,12 @@ module Couchbase
       # @param [String] index_name name of the index
       # @param [PauseIngestOptions] options
       #
+      # @return void
+      #
       # @raise [ArgumentError]
       # @raise [Error::IndexNotFound]
       def pause_ingest(index_name, options = PauseIngestOptions.new)
-        # POST /api/index/{index_name}/ingestControl/pause
+        @backend.search_index_pause_ingest(index_name, options.timeout)
       end
 
       # Resumes updates and maintenance for an index
@@ -96,10 +117,12 @@ module Couchbase
       # @param [String] index_name name of the index
       # @param [ResumeIngestOptions] options
       #
+      # @return void
+      #
       # @raise [ArgumentError]
       # @raise [Error::IndexNotFound]
       def resume_ingest(index_name, options = ResumeIngestOptions.new)
-        # POST /api/index/{index_name}/ingestControl/resume
+        @backend.search_index_resume_ingest(index_name, options.timeout)
       end
 
       # Allows querying against the index
@@ -107,10 +130,12 @@ module Couchbase
       # @param [String] index_name name of the index
       # @param [AllowQueryingOptions] options
       #
+      # @return void
+      #
       # @raise [ArgumentError]
       # @raise [Error::IndexNotFound]
       def allow_querying(index_name, options = AllowQueryingOptions.new)
-        # POST /api/index/{index_name}/queryControl/allow
+        @backend.search_index_allow_querying(index_name, options.timeout)
       end
 
       # Disallows querying against the index
@@ -118,10 +143,12 @@ module Couchbase
       # @param [String] index_name name of the index
       # @param [DisallowQueryingOptions] options
       #
+      # @return void
+      #
       # @raise [ArgumentError]
       # @raise [Error::IndexNotFound]
       def disallow_querying(index_name, options = DisallowQueryingOptions.new)
-        # POST /api/index/{index_name}/queryControl/disallow
+        @backend.search_index_disallow_querying(index_name, options.timeout)
       end
 
       # Freeze the assignment of index partitions to nodes
@@ -129,10 +156,12 @@ module Couchbase
       # @param [String] index_name name of the index
       # @param [FreezePlanOptions] options
       #
+      # @return void
+      #
       # @raise [ArgumentError]
       # @raise [Error::IndexNotFound]
       def freeze_plan(index_name, options = FreezePlanOptions.new)
-        # POST /api/index/{index_name}/planFreezeControl/freeze
+        @backend.search_index_freeze_plan(index_name, options.timeout)
       end
 
       # Unfreeze the assignment of index partitions to nodes
@@ -140,10 +169,12 @@ module Couchbase
       # @param [String] index_name name of the index
       # @param [UnfreezePlanOptions] options
       #
+      # @return void
+      #
       # @raise [ArgumentError]
       # @raise [Error::IndexNotFound]
       def unfreeze_plan(index_name, options = UnfreezePlanOptions.new)
-        # POST /api/index/{index_name}/planFreezeControl/unfreeze
+        @backend.search_index_unfreeze_plan(index_name, options.timeout)
       end
 
       # Allows to see how a document is analyzed against a specific index
@@ -156,7 +187,8 @@ module Couchbase
       # @raise [ArgumentError]
       # @raise [Error::IndexNotFound]
       def analyze_document(index_name, document, options = AnalyzeDocumentOptions.new)
-        # POST /api/index/{index_name}/analyzeDoc
+        res = @backend.search_index_analyze_document(index_name, JSON.generate(document), options.timeout)
+        JSON.parse(res[:analysis])
       end
 
       class GetIndexOptions
@@ -199,7 +231,7 @@ module Couchbase
         end
       end
 
-      class GetIndexedDocumentsOptions
+      class GetIndexedDocumentsCountOptions
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
@@ -278,6 +310,22 @@ module Couchbase
           yield self if block_given?
         end
       end
+
+      private
+
+      def extract_search_index(resp)
+        SearchIndex.new do |index|
+          index.name = resp[:name]
+          index.type = resp[:type]
+          index.uuid = resp[:uuid]
+          index.params = resp[:params] ? JSON.parse(resp[:params]) : {}
+          index.source_name = resp[:source_name]
+          index.source_type = resp[:source_type]
+          index.source_uuid = resp[:source_uuid]
+          index.source_params = resp[:source_params] ? JSON.parse(resp[:source_params]) : {}
+          index.plan_params = resp[:plan_params] ? JSON.parse(resp[:plan_params]) : {}
+        end
+      end
     end
 
     class SearchIndex
@@ -310,6 +358,8 @@ module Couchbase
 
       # @yieldparam [SearchIndex] self
       def initialize
+        @type = "fulltext-index"
+        @source_type = "couchbase"
         yield self if block_given?
       end
     end