Class BucketManager

BucketManager provides an interface for adding/removing/updating buckets within the cluster.

Index

Methods

createBucket dropBucket flushBucket getAllBuckets getBucket updateBucket

Methods

createBucket

createBucket(settings, options?, callback?): Promise<void>
Creates a new bucket.
Parameters
- settings: ICreateBucketSettings
  The settings to use for the new bucket.
- Optional options: CreateBucketOptions
  Optional parameters for this operation.
- Optional callback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/bucketmanager.ts:579

dropBucket

dropBucket(bucketName, options?, callback?): Promise<void>
Drops an existing bucket.
Parameters
- bucketName: string
  The name of the bucket to drop.
- Optional options: DropBucketOptions
  Optional parameters for this operation.
- Optional callback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/bucketmanager.ts:660

flushBucket

flushBucket(bucketName, options?, callback?): Promise<void>
Flushes the bucket, deleting all the existing data that is stored in it.
Parameters
- bucketName: string
  The name of the bucket to flush.
- Optional options: FlushBucketOptions
  Optional parameters for this operation.
- Optional callback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/bucketmanager.ts:783

getAllBuckets

getAllBuckets(options?, callback?): Promise<BucketSettings[]>
Returns a list of existing buckets in the cluster.
Parameters
- Optional options: GetAllBucketsOptions
  Optional parameters for this operation.
- Optional callback: NodeCallback<BucketSettings[]>
  A node-style callback to be invoked after execution.
Returns Promise<BucketSettings[]>
- Defined in lib/bucketmanager.ts:741

getBucket

getBucket(bucketName, options?, callback?): Promise<BucketSettings>
Fetches the settings in use for a specified bucket.
Parameters
- bucketName: string
  The name of the bucket to fetch settings for.
- Optional options: GetBucketOptions
  Optional parameters for this operation.
- Optional callback: NodeCallback<BucketSettings>
  A node-style callback to be invoked after execution.
Returns Promise<BucketSettings>
- Defined in lib/bucketmanager.ts:700

updateBucket

updateBucket(settings, options?, callback?): Promise<void>
Updates the settings for an existing bucket.
Parameters
- settings: BucketSettings
  The new settings to use for the bucket.
- Optional options: UpdateBucketOptions
  Optional parameters for this operation.
- Optional callback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/bucketmanager.ts:619