Class BucketManager

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

Hierarchy

  • BucketManager

Methods

  • Creates a new bucket.

    Parameters

    Returns 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>

  • 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>

  • Returns a list of existing buckets in the cluster.

    Parameters

    Returns 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>

  • 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>

Generated using TypeDoc