Class: Couchbase::Management::CollectionSpec

Inherits:

Object

• Object
• Couchbase::Management::CollectionSpec

Defined in:

lib/couchbase/management/collection_manager.rb,
/home/runner/work/couchbase-ruby-client/couchbase-ruby-client/lib/couchbase/management/collection_manager.rb

Instance Attribute Summary

• #history ⇒ Boolean^?

  Whether history retention is enabled for this collection.

• #max_expiry ⇒ Integer

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

• #name ⇒ String

  Name of the collection.

• #scope_name ⇒ String

  Name of the scope.

Instance Method Summary

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

  A new instance of CollectionSpec.

Constructor Details

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

Returns a new instance of CollectionSpec.

Yield Parameters:

• self (CollectionSpec)

# File 'lib/couchbase/management/collection_manager.rb', line 510

def initialize
  yield self if block_given?
end

Instance Attribute Details

#history ⇒ Boolean^?

Returns whether history retention is enabled for this collection.

Returns:

• (Boolean, nil) —

  whether history retention is enabled for this collection

# File 'lib/couchbase/management/collection_manager.rb', line 507

def history
  @history
end

#max_expiry ⇒ Integer

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)

# File 'lib/couchbase/management/collection_manager.rb', line 504

def max_expiry
  @max_expiry
end

#name ⇒ String

Returns name of the collection.

Returns:

• (String) —

  name of the collection

# File 'lib/couchbase/management/collection_manager.rb', line 498

def name
  @name
end

#scope_name ⇒ String

Returns name of the scope.

Returns:

• (String) —

  name of the scope

# File 'lib/couchbase/management/collection_manager.rb', line 501

def scope_name
  @scope_name
end