Class

BucketManager

BucketManager

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

Methods

async createBucket(settings, optionsopt, callbackopt) → {Promise.<boolean>}

Parameters:
Name Type Attributes Description
settings BucketSettings
options * <optional>
timeout number <optional>
callback CreateBucketCallback <optional>

View Source bucketmanager.js, line 61

Promise.<boolean>

async dropBucket(bucketName, optionsopt, callbackopt) → {Promise.<boolean>}

Parameters:
Name Type Attributes Description
bucketName string
options * <optional>
timeout number <optional>
callback DropBucketCallback <optional>

View Source bucketmanager.js, line 157

Promise.<boolean>

async flushBucket(bucketName, optionsopt, callbackopt) → {Promise.<boolean>}

Parameters:
Name Type Attributes Description
bucketName string
options * <optional>
timeout number <optional>
callback FlushBucketCallback <optional>

View Source bucketmanager.js, line 288

Promise.<boolean>

async getAllBuckets(bucketName, optionsopt, callbackopt) → {Promise.<Array.<BucketSettings>>}

Parameters:
Name Type Attributes Description
bucketName string
options * <optional>
timeout number <optional>
callback GetAllBucketsCallback <optional>

View Source bucketmanager.js, line 248

Promise.<Array.<BucketSettings>>

async getBucket(bucketName, optionsopt, callbackopt) → {Promise.<BucketSettings>}

Parameters:
Name Type Attributes Description
bucketName string
options * <optional>
timeout number <optional>
callback GetBucketCallback <optional>

View Source bucketmanager.js, line 203

Promise.<BucketSettings>

async updateBucket(settings, optionsopt, callbackopt) → {Promise.<boolean>}

Parameters:
Name Type Attributes Description
settings BucketSettings
options * <optional>
timeout number <optional>
callback UpdateBucketCallback <optional>

View Source bucketmanager.js, line 109

Promise.<boolean>