Class: Couchbase::Management::BucketSettings

Inherits:
Object
  • Object
show all
Extended by:
Gem::Deprecate
Defined in:
lib/couchbase/management/bucket_manager.rb,
/Users/sergey.auseyau/code/couchbase-ruby-client/lib/couchbase/management/bucket_manager.rb more...

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of BucketSettings.

Yield Parameters:

[View source]

413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/couchbase/management/bucket_manager.rb', line 413

def initialize
  @bucket_type = :couchbase
  @name = nil
  @minimum_durability_level = nil
  @healthy = true
  @flush_enabled = false
  @ram_quota_mb = 100
  @num_replicas = 1
  @replica_indexes = false
  @max_expiry = 0
  @compression_mode = :passive
  @conflict_resolution_type = :sequence_number
  @eviction_policy = :value_only
  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


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

def bucket_type
  @bucket_type
end

#compression_mode ⇒ :off, ...

Returns the compression mode to use.

Returns:

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

    the compression mode to use


384
385
386
 
# File 'lib/couchbase/management/bucket_manager.rb', line 384

def compression_mode
  @compression_mode
end

#conflict_resolution_type ⇒ :timestamp, :sequence_number

Returns conflict resolution policy.

Returns:

  • (:timestamp, :sequence_number) —

    conflict resolution policy


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

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


378
379
380
 
# File 'lib/couchbase/management/bucket_manager.rb', line 378

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.


346
347
348
 
# File 'lib/couchbase/management/bucket_manager.rb', line 346

def flush_enabled
  @flush_enabled
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


381
382
383
 
# File 'lib/couchbase/management/bucket_manager.rb', line 381

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


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

def minimum_durability_level
  @minimum_durability_level
end

#name ⇒ String

Returns name of the bucket.

Returns:

  • (String) —

    name of the bucket


343
344
345
 
# File 'lib/couchbase/management/bucket_manager.rb', line 343

def name
  @name
end

#num_replicas ⇒ Integer

Returns number of replicas for documents.

Returns:

  • (Integer) —

    number of replicas for documents


352
353
354
 
# File 'lib/couchbase/management/bucket_manager.rb', line 352

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


349
350
351
 
# File 'lib/couchbase/management/bucket_manager.rb', line 349

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


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

def replica_indexes
  @replica_indexes
end

Instance Method Details

#ejection_policy ⇒ Object

Deprecated.

Use #eviction_policy instead

[View source]

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

def ejection_policy
  @eviction_policy
end

#ejection_policy=(val) ⇒ Object

Deprecated.

Use #eviction_policy= instead

[View source]

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

def ejection_policy=(val)
  @eviction_policy = val
end