Class: Couchbase::Management::BucketSettings

Inherits:
Object
  • Object
show all
Extended by:
Gem::Deprecate
Defined in:
lib/couchbase/management/bucket_manager.rb,
/home/runner/work/couchbase-ruby-client/couchbase-ruby-client/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:



474
475
476
 
# File 'lib/couchbase/management/bucket_manager.rb', line 474

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



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

def bucket_type
  @bucket_type
end

#compression_mode ⇒ :off, ...

Returns the compression mode to use.

Returns:

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

    the compression mode to use



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

def compression_mode
  @compression_mode
end

#conflict_resolution_type ⇒ :timestamp, ...

Returns conflict resolution policy.

Returns:

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

    conflict resolution policy



434
435
436
 
# File 'lib/couchbase/management/bucket_manager.rb', line 434

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



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

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.



390
391
392
 
# File 'lib/couchbase/management/bucket_manager.rb', line 390

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



444
445
446
 
# File 'lib/couchbase/management/bucket_manager.rb', line 444

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



440
441
442
 
# File 'lib/couchbase/management/bucket_manager.rb', line 440

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



448
449
450
 
# File 'lib/couchbase/management/bucket_manager.rb', line 448

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



428
429
430
 
# File 'lib/couchbase/management/bucket_manager.rb', line 428

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



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

def minimum_durability_level
  @minimum_durability_level
end

#name ⇒ String

Returns name of the bucket.

Returns:

  • (String) —

    name of the bucket



387
388
389
 
# File 'lib/couchbase/management/bucket_manager.rb', line 387

def name
  @name
end

#num_replicas ⇒ Integer

Returns number of replicas for documents.

Returns:

  • (Integer) —

    number of replicas for documents



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

def num_replicas
  @num_replicas
end

#num_vbuckets ⇒ Integer?

Returns the number of vBuckets the bucket should have. If not set, the server default will be used.

Returns:

  • (Integer, nil) —

    the number of vBuckets the bucket should have. If not set, the server default will be used



451
452
453
 
# File 'lib/couchbase/management/bucket_manager.rb', line 451

def num_vbuckets
  @num_vbuckets
end

#ram_quota_mb ⇒ Integer

Returns RAM quota in megabytes for the bucket.

Returns:

  • (Integer) —

    RAM quota in megabytes for the bucket



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

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



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

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



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

def storage_backend
  @storage_backend
end

Instance Method Details

#ejection_policy ⇒ Object

Deprecated.

Use #eviction_policy instead



460
461
462
 
# File 'lib/couchbase/management/bucket_manager.rb', line 460

def ejection_policy
  @eviction_policy
end

#ejection_policy=(val) ⇒ Object

Deprecated.

Use #eviction_policy= instead



467
468
469
 
# File 'lib/couchbase/management/bucket_manager.rb', line 467

def ejection_policy=(val)
  @eviction_policy = val
end