couchbase 3.0.0.alpha.2 → 3.0.0.alpha.3

data/lib/couchbase/collection_options.rb

@@ -21,7 +21,7 @@ module Couchbase
   class Collection
     class GetOptions < CommonOptions
       # @return [Boolean] if the expiration should also fetched with get
-      attr_accessor :with_expiry
+      attr_accessor :with_expiration
 
       # @return [JsonTranscoder] transcoder used for decoding
       attr_accessor :transcoder
@@ -29,6 +29,9 @@ module Couchbase
       # @yieldparam [GetOptions] self
       def initialize
         @transcoder = JsonTranscoder.new
+        @preserve_array_indexes = false
+        @with_expiration = nil
+        @projections = nil
         yield self if block_given?
       end
 
@@ -40,7 +43,21 @@ module Couchbase
       # @param [String, Array<String>] paths a path that should be loaded if present.
       def project(*paths)
         @projections ||= []
-        @projections |= paths # union with current projections
+        @projections |= paths.flatten # union with current projections
+      end
+
+      # @api private
+      # @return [Boolean] whether to use sparse arrays (default false)
+      attr_accessor :preserve_array_indexes
+
+      # @api private
+      # @return [Array<String>] list of paths to project
+      attr_accessor :projections
+
+      # @api private
+      # @return [Boolean]
+      def need_projected_get?
+        @with_expiration || !@projections.nil?
       end
     end
 

data/lib/couchbase/json_transcoder.rb

@@ -22,11 +22,11 @@ module Couchbase
       [JSON.generate(document), (0x02 << 24) | 0x06]
     end
 
-    # @param [String] blob string of bytes, containing encoded representation of the document
+    # @param [String, nil] 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)
+      JSON.parse(blob) unless blob.nil?
     end
   end
 end

data/lib/couchbase/management/bucket_manager.rb

@@ -29,20 +29,25 @@ 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,
-            num_replicas: settings.num_replicas,
-            replica_indexes: settings.replica_indexes,
-            bucket_type: settings.bucket_type,
-            ejection_policy: settings.ejection_policy,
-            max_expiry: settings.max_expiry,
-            compression_mode: settings.compression_mode,
-            conflict_resolution_type: settings.conflict_resolution_type,
+            {
+
+                name: settings.name,
+                flush_enabled: settings.flush_enabled,
+                ram_quota_mb: settings.ram_quota_mb,
+                num_replicas: settings.num_replicas,
+                replica_indexes: settings.replica_indexes,
+                bucket_type: settings.bucket_type,
+                ejection_policy: settings.ejection_policy,
+                max_expiry: settings.max_expiry,
+                compression_mode: settings.compression_mode,
+                conflict_resolution_type: settings.conflict_resolution_type,
+            }, options.timeout
         )
       end
 
@@ -51,19 +56,23 @@ 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,
-            num_replicas: settings.num_replicas,
-            replica_indexes: settings.replica_indexes,
-            bucket_type: settings.bucket_type,
-            ejection_policy: settings.ejection_policy,
-            max_expiry: settings.max_expiry,
-            compression_mode: settings.compression_mode,
+            {
+                name: settings.name,
+                flush_enabled: settings.flush_enabled,
+                ram_quota_mb: settings.ram_quota_mb,
+                num_replicas: settings.num_replicas,
+                replica_indexes: settings.replica_indexes,
+                bucket_type: settings.bucket_type,
+                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

@@ -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

@@ -33,7 +33,7 @@ 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]
@@ -55,6 +55,8 @@ 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)
@@ -63,7 +65,7 @@ module Couchbase
             condition: options.condition,
             deferred: options.deferred,
             num_replicas: options.num_replicas,
-        })
+        }, options.timeout)
       end
 
       # Creates new primary index
@@ -71,6 +73,8 @@ 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)
@@ -78,7 +82,7 @@ module Couchbase
             ignore_if_exists: options.ignore_if_exists,
             deferred: options.deferred,
             num_replicas: options.num_replicas,
-        })
+        }, options.timeout)
       end
 
       # Drops the index
@@ -87,12 +91,14 @@ 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,
-        })
+        }, options.timeout)
         true
       end
 
@@ -101,13 +107,15 @@ 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,
-        })
+        }, options.timeout)
         true
       end
 
@@ -116,9 +124,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

data/lib/couchbase/management/search_index_manager.rb

@@ -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,22 @@ 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 +76,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 +103,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 +116,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 +129,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 +142,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 +155,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 +168,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 +186,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 +230,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 +309,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