Class BucketManager

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

Hierarchy

BucketManager

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.
- 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:552

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.
- 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:650

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.
- 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:788

getAllBuckets

getAllBuckets(options?: GetAllBucketsOptions, callback?: NodeCallback<BucketSettings[]>): 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:742

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.
- 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:695

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.
- 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:601

Class BucketManager

Hierarchy

Index

Methods

Methods

createBucket

Parameters

settings: ICreateBucketSettings

Optional options: CreateBucketOptions

Optional callback: NodeCallback<void>

Returns Promise<void>

dropBucket

Parameters

bucketName: string

Optional options: DropBucketOptions

Optional callback: NodeCallback<void>

Returns Promise<void>

flushBucket

Parameters

bucketName: string

Optional options: FlushBucketOptions

Optional callback: NodeCallback<void>

Returns Promise<void>

getAllBuckets

Parameters

Optional options: GetAllBucketsOptions

Optional callback: NodeCallback<BucketSettings[]>

Returns Promise<BucketSettings[]>

getBucket

Parameters

bucketName: string

Optional options: GetBucketOptions

Optional callback: NodeCallback<BucketSettings>

Returns Promise<BucketSettings>

updateBucket

Parameters

settings: BucketSettings

Optional options: UpdateBucketOptions

Optional callback: NodeCallback<void>

Returns Promise<void>

Settings

Member Visibility

Theme

`Optional` options: CreateBucketOptions

`Optional` callback: NodeCallback<void>

`Optional` options: DropBucketOptions

`Optional` callback: NodeCallback<void>

`Optional` options: FlushBucketOptions

`Optional` callback: NodeCallback<void>

`Optional` options: GetAllBucketsOptions

`Optional` callback: NodeCallback<BucketSettings[]>

`Optional` options: GetBucketOptions

`Optional` callback: NodeCallback<BucketSettings>

`Optional` options: UpdateBucketOptions

`Optional` callback: NodeCallback<void>