Class: Couchbase::Management::BucketSettings
- Inherits:
-
Object
- Object
- Couchbase::Management::BucketSettings
- Extended by:
- Gem::Deprecate
- Defined in:
- lib/couchbase/management/bucket_manager.rb
Instance Attribute Summary collapse
-
#bucket_type ⇒ :couchbase, ...
The type of the bucket.
-
#compression_mode ⇒ :off, ...
The compression mode to use.
-
#conflict_resolution_type ⇒ :timestamp, ...
Conflict resolution policy.
-
#eviction_policy ⇒ :full, ...
Eviction policy to use.
-
#flush_enabled ⇒ Boolean
Whether or not flush should be enabled on the bucket.
-
#history_retention_bytes ⇒ Integer?
collections in this bucket.
-
#history_retention_collection_default ⇒ Boolean?
Whether to enable history retention on collections by default.
-
#history_retention_duration ⇒ Integer?
collections in this bucket.
-
#max_expiry ⇒ Integer
Value of TTL (expiration) in seconds for new documents created without expiration.
-
#minimum_durability_level ⇒ nil, ...
The minimum durability level.
-
#name ⇒ String
Name of the bucket.
-
#num_replicas ⇒ Integer
Number of replicas for documents.
-
#ram_quota_mb ⇒ Integer
RAM quota in megabytes for the bucket.
-
#replica_indexes ⇒ Boolean
Whether replica indexes should be enabled for the bucket.
-
#storage_backend ⇒ nil, ...
The type of the storage backend of the bucket.
Instance Method Summary collapse
-
#ejection_policy ⇒ Object
deprecated
Deprecated.
Use #eviction_policy instead
-
#ejection_policy=(val) ⇒ Object
deprecated
Deprecated.
Use #eviction_policy= instead
-
#healthy? ⇒ Boolean
private
False if status of the bucket is not healthy.
-
#initialize {|self| ... } ⇒ BucketSettings
constructor
A new instance of BucketSettings.
Constructor Details
#initialize {|self| ... } ⇒ BucketSettings
Returns a new instance of BucketSettings.
440 441 442 |
# File 'lib/couchbase/management/bucket_manager.rb', line 440 def initialize yield self if block_given? end |
Instance Attribute Details
#bucket_type ⇒ :couchbase, ...
Returns the type of the bucket. Defaults to :couchbase
.
371 372 373 |
# File 'lib/couchbase/management/bucket_manager.rb', line 371 def bucket_type @bucket_type end |
#compression_mode ⇒ :off, ...
Returns the compression mode to use.
400 401 402 |
# File 'lib/couchbase/management/bucket_manager.rb', line 400 def compression_mode @compression_mode end |
#conflict_resolution_type ⇒ :timestamp, ...
Returns conflict resolution policy.
403 404 405 |
# File 'lib/couchbase/management/bucket_manager.rb', line 403 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
.
394 395 396 |
# File 'lib/couchbase/management/bucket_manager.rb', line 394 def eviction_policy @eviction_policy end |
#flush_enabled ⇒ Boolean
Returns whether or not flush should be enabled on the bucket. Defaults to false.
359 360 361 |
# File 'lib/couchbase/management/bucket_manager.rb', line 359 def flush_enabled @flush_enabled end |
#history_retention_bytes ⇒ Integer?
collections in this bucket
413 414 415 |
# File 'lib/couchbase/management/bucket_manager.rb', line 413 def history_retention_bytes @history_retention_bytes end |
#history_retention_collection_default ⇒ Boolean?
Returns whether to enable history retention on collections by default.
409 410 411 |
# File 'lib/couchbase/management/bucket_manager.rb', line 409 def history_retention_collection_default @history_retention_collection_default end |
#history_retention_duration ⇒ Integer?
collections in this bucket
417 418 419 |
# File 'lib/couchbase/management/bucket_manager.rb', line 417 def history_retention_duration @history_retention_duration end |
#max_expiry ⇒ Integer
Returns value of TTL (expiration) in seconds for new documents created without expiration.
397 398 399 |
# File 'lib/couchbase/management/bucket_manager.rb', line 397 def max_expiry @max_expiry end |
#minimum_durability_level ⇒ nil, ...
Returns the minimum durability level.
406 407 408 |
# File 'lib/couchbase/management/bucket_manager.rb', line 406 def minimum_durability_level @minimum_durability_level end |
#name ⇒ String
Returns name of the bucket.
356 357 358 |
# File 'lib/couchbase/management/bucket_manager.rb', line 356 def name @name end |
#num_replicas ⇒ Integer
Returns number of replicas for documents.
365 366 367 |
# File 'lib/couchbase/management/bucket_manager.rb', line 365 def num_replicas @num_replicas end |
#ram_quota_mb ⇒ Integer
Returns RAM quota in megabytes for the bucket.
362 363 364 |
# File 'lib/couchbase/management/bucket_manager.rb', line 362 def ram_quota_mb @ram_quota_mb end |
#replica_indexes ⇒ Boolean
Returns whether replica indexes should be enabled for the bucket.
368 369 370 |
# File 'lib/couchbase/management/bucket_manager.rb', line 368 def replica_indexes @replica_indexes end |
#storage_backend ⇒ nil, ...
Returns the type of the storage backend of the bucket.
374 375 376 |
# File 'lib/couchbase/management/bucket_manager.rb', line 374 def storage_backend @storage_backend end |
Instance Method Details
#ejection_policy ⇒ Object
Use #eviction_policy instead
426 427 428 |
# File 'lib/couchbase/management/bucket_manager.rb', line 426 def ejection_policy @eviction_policy end |
#ejection_policy=(val) ⇒ Object
Use #eviction_policy= instead
433 434 435 |
# File 'lib/couchbase/management/bucket_manager.rb', line 433 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.
421 422 423 |
# File 'lib/couchbase/management/bucket_manager.rb', line 421 def healthy? @healthy end |