Class: Couchbase::Management::CreateCollectionSettings

Inherits:
Object
  • Object
show all
Defined in:
lib/couchbase/management/collection_manager.rb

Constant Summary collapse

DEFAULT = 
CreateCollectionSettings.new.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(max_expiry: nil, history: nil) {|_self| ... } ⇒ CreateCollectionSettings

Returns a new instance of CreateCollectionSettings.

Yields:

  • (_self)

Yield Parameters:



438
439
440
441
442
443
 
# File 'lib/couchbase/management/collection_manager.rb', line 438

def initialize(max_expiry: nil, history: nil)
  @max_expiry = max_expiry
  @history = history

  yield self if block_given?
end

Instance Attribute Details

#history ⇒ Boolean?

default to the bucket-level setting)

Returns:

  • (Boolean, nil) —

    whether history retention override should be enabled in the collection (set to nil to



436
437
438
 
# File 'lib/couchbase/management/collection_manager.rb', line 436

def history
  @history
end

#max_expiry ⇒ Integer?

(set to nil to use the bucket-level setting, and to -1 set it to no-expiry)

Returns:

  • (Integer, nil) —

    time in seconds of the maximum expiration time for new documents in the collection



432
433
434
 
# File 'lib/couchbase/management/collection_manager.rb', line 432

def max_expiry
  @max_expiry
end

Instance Method Details

#to_backend ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



446
447
448
449
450
451
 
# File 'lib/couchbase/management/collection_manager.rb', line 446

def to_backend
  {
    max_expiry: @max_expiry,
    history: @history,
  }
end