Class: Couchbase::Management::BucketManager

Inherits:

Object

• Object
• Couchbase::Management::BucketManager

Defined in:

lib/couchbase/management/bucket_manager.rb

Instance Method Summary

• #create_bucket(settings, options = Options::Bucket::CreateBucket.new) ⇒ Object

  Creates new bucket.

• #drop_bucket(bucket_name, options = Options::Bucket::DropBucket.new) ⇒ Object

  Removes a bucket.

• #flush_bucket(bucket_name, options = Options::Bucket::FlushBucket.new) ⇒ Object

  Void.

• #get_all_buckets(options = Options::Bucket::GetAllBuckets.new) ⇒ Array<BucketSettings>

  Get settings for all buckets.

• #get_bucket(bucket_name, options = Options::Bucket::GetBucket.new) ⇒ BucketSettings

  Fetch settings of the bucket.

• #initialize(backend) ⇒ BucketManager constructor

  A new instance of BucketManager.

• #update_bucket(settings, options = Options::Bucket::UpdateBucket.new) ⇒ Object

  Updates the bucket settings.

Constructor Details

#initialize(backend) ⇒ BucketManager

Returns a new instance of BucketManager.

Parameters:

• backend (Couchbase::Backend)

# File 'lib/couchbase/management/bucket_manager.rb', line 191

def initialize(backend)
  @backend = backend
end

Instance Method Details

#create_bucket(settings, options = Options::Bucket::CreateBucket.new) ⇒ Object

Creates new bucket

Parameters:

• settings (BucketSettings) —

  bucket settings

• options (Options::Bucket::CreateBucket) (defaults to: Options::Bucket::CreateBucket.new)

Returns:

• void

Raises:

• (ArgumentError)
• (Error::BucketExists)

# File 'lib/couchbase/management/bucket_manager.rb', line 204

def create_bucket(settings, options = Options::Bucket::CreateBucket.new)
  @backend.bucket_create(
    {

      name: settings.name,
      flush_enabled: settings.flush_enabled,
      ram_quota_mb: settings.ram_quota_mb,
      num_replicas: settings.num_replicas,
      replica_indexes: settings.replica_indexes,
      bucket_type: settings.bucket_type,
      eviction_policy: settings.eviction_policy,
      max_expiry: settings.max_expiry,
      compression_mode: settings.compression_mode,
      minimum_durability_level: settings.minimum_durability_level,
      conflict_resolution_type: settings.conflict_resolution_type,
      storage_backend: settings.storage_backend,
      history_retention_collection_default: settings.history_retention_collection_default,
      history_retention_duration: settings.history_retention_duration,
      history_retention_bytes: settings.history_retention_bytes,
    }, options.to_backend
  )
end

#drop_bucket(bucket_name, options = Options::Bucket::DropBucket.new) ⇒ Object

Removes a bucket

Parameters:

• bucket_name (String) —

  name of the bucket

• options (Options::Bucket::DropBucket) (defaults to: Options::Bucket::DropBucket.new)

Returns:

• void

Raises:

• (ArgumentError)
• (Error::BucketNotFound)

# File 'lib/couchbase/management/bucket_manager.rb', line 266

def drop_bucket(bucket_name, options = Options::Bucket::DropBucket.new)
  @backend.bucket_drop(bucket_name, options.to_backend)
end

#flush_bucket(bucket_name, options = Options::Bucket::FlushBucket.new) ⇒ Object

Returns void.

Parameters:

• bucket_name (String) —

  name of the bucket

• options (Options::Bucket::FlushBucket) (defaults to: Options::Bucket::FlushBucket.new)

Returns:

• void

Raises:

• (ArgumentError)
• (Error::BucketNotFound)
• (Error::BucketNotFlushable)

# File 'lib/couchbase/management/bucket_manager.rb', line 300

def flush_bucket(bucket_name, options = Options::Bucket::FlushBucket.new)
  @backend.bucket_flush(bucket_name, options.to_backend)
end

#get_all_buckets(options = Options::Bucket::GetAllBuckets.new) ⇒ Array<BucketSettings>

Get settings for all buckets

Parameters:

• options (Options::Bucket::GetAllBuckets) (defaults to: Options::Bucket::GetAllBuckets.new)

Returns:

• (Array<BucketSettings>)

# File 'lib/couchbase/management/bucket_manager.rb', line 287

def get_all_buckets(options = Options::Bucket::GetAllBuckets.new)
  @backend.bucket_get_all(options.to_backend)
          .map { |entry| extract_bucket_settings(entry) }
end

#get_bucket(bucket_name, options = Options::Bucket::GetBucket.new) ⇒ BucketSettings

Fetch settings of the bucket

Parameters:

• bucket_name (String) —

  name of the bucket

• options (Options::Bucket::GetBucket) (defaults to: Options::Bucket::GetBucket.new)

Returns:

• (BucketSettings)

Raises:

• (ArgumentError)
• (Error::BucketNotFound)

# File 'lib/couchbase/management/bucket_manager.rb', line 279

def get_bucket(bucket_name, options = Options::Bucket::GetBucket.new)
  extract_bucket_settings(@backend.bucket_get(bucket_name, options.to_backend))
end

#update_bucket(settings, options = Options::Bucket::UpdateBucket.new) ⇒ Object

Updates the bucket settings

Parameters:

• settings (BucketSettings) —

  bucket settings

• options (Options::Bucket::UpdateBucket) (defaults to: Options::Bucket::UpdateBucket.new)

Returns:

• void

Raises:

• (ArgumentError)
• (Error::BucketNotFound)

# File 'lib/couchbase/management/bucket_manager.rb', line 236

def update_bucket(settings, options = Options::Bucket::UpdateBucket.new)
  @backend.bucket_update(
    {
      name: settings.name,
      flush_enabled: settings.flush_enabled,
      ram_quota_mb: settings.ram_quota_mb,
      num_replicas: settings.num_replicas,
      replica_indexes: settings.replica_indexes,
      bucket_type: settings.bucket_type,
      eviction_policy: settings.eviction_policy,
      max_expiry: settings.max_expiry,
      compression_mode: settings.compression_mode,
      minimum_durability_level: settings.minimum_durability_level,
      storage_backend: settings.storage_backend,
      history_retention_collection_default: settings.history_retention_collection_default,
      history_retention_bytes: settings.history_retention_bytes,
      history_retention_duration: settings.history_retention_duration,
    }, options.to_backend
  )
end