Class: Couchbase::Management::CollectionSpec

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize {|self| ... } ⇒ CollectionSpec

Returns a new instance of CollectionSpec.

Yield Parameters:



465
466
467
# File 'lib/couchbase/management/collection_manager.rb', line 465

def initialize
  yield self if block_given?
end

Instance Attribute Details

#historyBoolean?

Returns whether history retention is enabled for this collection.

Returns:

  • (Boolean, nil)

    whether history retention is enabled for this collection



462
463
464
# File 'lib/couchbase/management/collection_manager.rb', line 462

def history
  @history
end

#max_expiryInteger

Returns time in seconds of the expiration for new documents in the collection (set to nil to disable it).

Returns:

  • (Integer)

    time in seconds of the expiration for new documents in the collection (set to nil to disable it)



459
460
461
# File 'lib/couchbase/management/collection_manager.rb', line 459

def max_expiry
  @max_expiry
end

#nameString

Returns name of the collection.

Returns:

  • (String)

    name of the collection



453
454
455
# File 'lib/couchbase/management/collection_manager.rb', line 453

def name
  @name
end

#scope_nameString

Returns name of the scope.

Returns:

  • (String)

    name of the scope



456
457
458
# File 'lib/couchbase/management/collection_manager.rb', line 456

def scope_name
  @scope_name
end