Class: Couchbase::Management::BucketSettings

Inherits:
Object
  • Object
show all
Extended by:
Gem::Deprecate
Defined in:
lib/couchbase/management/bucket_manager.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of BucketSettings.

Yield Parameters:



438
439
440
 
# File 'lib/couchbase/management/bucket_manager.rb', line 438

def initialize
  yield self if block_given?
end

Instance Attribute Details

#bucket_type ⇒ :couchbase, ...

Returns the type of the bucket. Defaults to :couchbase.

Returns:

  • (:couchbase, :memcached, :ephemeral) —

    the type of the bucket. Defaults to :couchbase



369
370
371
 
# File 'lib/couchbase/management/bucket_manager.rb', line 369

def bucket_type
  @bucket_type
end

#compression_mode ⇒ :off, ...

Returns the compression mode to use.

Returns:

  • (:off, :passive, :active) —

    the compression mode to use



398
399
400
 
# File 'lib/couchbase/management/bucket_manager.rb', line 398

def compression_mode
  @compression_mode
end

#conflict_resolution_type ⇒ :timestamp, ...

Returns conflict resolution policy.

Returns:

  • (:timestamp, :sequence_number, :custom) —

    conflict resolution policy



401
402
403
 
# File 'lib/couchbase/management/bucket_manager.rb', line 401

def conflict_resolution_type
  @conflict_resolution_type
end

#eviction_policy ⇒ :full, ...

Eviction policy to use

:full

During ejection, only the value will be ejected (key and metadata will remain in memory). Value Ejection needs more system memory, but provides better performance than Full Ejection. This value is only valid for buckets of type :couchbase.

:value_only

During ejection, everything (including key, metadata, and value) will be ejected. Full Ejection reduces the memory overhead requirement, at the cost of performance. This value is only valid for buckets of type :couchbase.

:no_eviction

Couchbase Server keeps all data until explicitly deleted, but will reject any new data if you reach the quota (dedicated memory) you set for your bucket. This value is only valid for buckets of type :ephemeral.

:not_recently_used

When the memory quota is reached, Couchbase Server ejects data that has not been used recently. This value is only valid for buckets of type :ephemeral.

Returns:

  • (:full, :value_only, :no_eviction, :not_recently_used) —

    the eviction policy to use



392
393
394
 
# File 'lib/couchbase/management/bucket_manager.rb', line 392

def eviction_policy
  @eviction_policy
end

#flush_enabled ⇒ Boolean

Returns whether or not flush should be enabled on the bucket. Defaults to false.

Returns:

  • (Boolean) —

    whether or not flush should be enabled on the bucket. Defaults to false.



357
358
359
 
# File 'lib/couchbase/management/bucket_manager.rb', line 357

def flush_enabled
  @flush_enabled
end

#history_retention_bytes ⇒ Integer?

collections in this bucket

Returns:

  • (Integer, nil) —

    the maximum size, in bytes, of the change history that is written to disk for all



411
412
413
 
# File 'lib/couchbase/management/bucket_manager.rb', line 411

def history_retention_bytes
  @history_retention_bytes
end

#history_retention_collection_default ⇒ Boolean?

Returns whether to enable history retention on collections by default.

Returns:

  • (Boolean, nil) —

    whether to enable history retention on collections by default



407
408
409
 
# File 'lib/couchbase/management/bucket_manager.rb', line 407

def history_retention_collection_default
  @history_retention_collection_default
end

#history_retention_duration ⇒ Integer?

collections in this bucket

Returns:

  • (Integer, nil) —

    the maximum duration, in seconds, to be covered by the change history that is written to disk for all



415
416
417
 
# File 'lib/couchbase/management/bucket_manager.rb', line 415

def history_retention_duration
  @history_retention_duration
end

#max_expiry ⇒ Integer

Returns value of TTL (expiration) in seconds for new documents created without expiration.

Returns:

  • (Integer) —

    value of TTL (expiration) in seconds for new documents created without expiration



395
396
397
 
# File 'lib/couchbase/management/bucket_manager.rb', line 395

def max_expiry
  @max_expiry
end

#minimum_durability_level ⇒ nil, ...

Returns the minimum durability level.

Returns:

  • (nil, :none, :majority, :majority_and_persist_to_active, :persist_to_majority) —

    the minimum durability level



404
405
406
 
# File 'lib/couchbase/management/bucket_manager.rb', line 404

def minimum_durability_level
  @minimum_durability_level
end

#name ⇒ String

Returns name of the bucket.

Returns:

  • (String) —

    name of the bucket



354
355
356
 
# File 'lib/couchbase/management/bucket_manager.rb', line 354

def name
  @name
end

#num_replicas ⇒ Integer

Returns number of replicas for documents.

Returns:

  • (Integer) —

    number of replicas for documents



363
364
365
 
# File 'lib/couchbase/management/bucket_manager.rb', line 363

def num_replicas
  @num_replicas
end

#ram_quota_mb ⇒ Integer

Returns RAM quota in megabytes for the bucket.

Returns:

  • (Integer) —

    RAM quota in megabytes for the bucket



360
361
362
 
# File 'lib/couchbase/management/bucket_manager.rb', line 360

def ram_quota_mb
  @ram_quota_mb
end

#replica_indexes ⇒ Boolean

Returns whether replica indexes should be enabled for the bucket.

Returns:

  • (Boolean) —

    whether replica indexes should be enabled for the bucket



366
367
368
 
# File 'lib/couchbase/management/bucket_manager.rb', line 366

def replica_indexes
  @replica_indexes
end

#storage_backend ⇒ nil, ...

Returns the type of the storage backend of the bucket.

Returns:

  • (nil, :couchstore, :magma) —

    the type of the storage backend of the bucket



372
373
374
 
# File 'lib/couchbase/management/bucket_manager.rb', line 372

def storage_backend
  @storage_backend
end

Instance Method Details

#ejection_policy ⇒ Object

Deprecated.

Use #eviction_policy instead



424
425
426
 
# File 'lib/couchbase/management/bucket_manager.rb', line 424

def ejection_policy
  @eviction_policy
end

#ejection_policy=(val) ⇒ Object

Deprecated.

Use #eviction_policy= instead



431
432
433
 
# File 'lib/couchbase/management/bucket_manager.rb', line 431

def ejection_policy=(val)
  @eviction_policy = val
end

#healthy? ⇒ Boolean

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.

Returns false if status of the bucket is not healthy.

Returns:

  • (Boolean) —

    false if status of the bucket is not healthy



419
420
421
 
# File 'lib/couchbase/management/bucket_manager.rb', line 419

def healthy?
  @healthy
end