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

dropBucket

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

flushBucket

flushBucket(
    bucketName: string,
    options?: FlushBucketOptions,
    callback?: NodeCallback<void>,
): 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.
- Optionaloptions: FlushBucketOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/bucketmanager.ts:783

getAllBuckets

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

getBucket

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

updateBucket

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