Class: BucketManager

BucketManager

A class for performing management operations against a bucket. This class should not be instantiated directly, but instead through the use of the Bucket#manager method instead.


<private> new BucketManager(bucket)

Parameters:
Name Type Description
bucket
Since:
  • 2.0.0 (stability: committed)

Methods


buildDeferredIndexes(callback)

Builds any indexes that were previously created with the deferred attribute.

Parameters:
Name Type Description
callback
Since:
  • 2.1.6 (stability: committed)

createIndex(indexName, fields, options, callback)

Creates a non-primary GSI index from a name and list of fields.

Parameters:
Name Type Description
indexName
fields
options
Properties
Name Type Description
ignoreIfExists
deferred
callback
Since:
  • 2.1.6 (stability: committed)

createPrimaryIndex(options, callback)

Creates a primary GSI index with an optional name

Parameters:
Name Type Description
options
Properties
Name Type Description
ignoreIfExists
deferred
callback
Since:
  • 2.1.6 (stability: committed)

dropIndex(indexName, options, callback)

Drops a specific GSI index by name.

Parameters:
Name Type Description
indexName
options
Properties
Name Type Description
ignoreIfNotExists
callback
Since:
  • 2.1.6 (stability: committed)

dropPrimaryIndex(options, callback)

Drops a primary GSI index

Parameters:
Name Type Description
options
Properties
Name Type Description
ignoreIfNotExists
callback
Since:
  • 2.1.6 (stability: committed)

flush(callback)

Flushes the cluster, deleting all data stored within this bucket. Note that this method requires the Flush permission to be enabled on the bucket from the management console before it will work.

Parameters:
Name Type Description
callback
Since:
  • 2.0.0 (stability: committed)

getDesignDocument(name, callback)

Retrieves a specific design document from this bucket.

Parameters:
Name Type Description
name
callback
Since:
  • 2.0.0 (stability: committed)

getDesignDocuments(callback)

Retrieves a list of all design documents registered to a bucket.

Parameters:
Name Type Description
callback
Since:
  • 2.0.0 (stability: committed)

getIndexes(callback)

Retreives a list of the indexes currently configured on the cluster.

Parameters:
Name Type Description
callback
Since:
  • 2.1.6 (stability: committed)

insertDesignDocument(name, data, callback)

Registers a design document to this bucket, failing if it already exists.

Parameters:
Name Type Description
name
data
callback
Since:
  • 2.0.0 (stability: committed)

removeDesignDocument(name, callback)

Unregisters a design document from this bucket.

Parameters:
Name Type Description
name
callback
Since:
  • 2.0.0 (stability: committed)

upsertDesignDocument(name, data, callback)

Registers a design document to this bucket, overwriting any existing design document that was previously registered.

Parameters:
Name Type Description
name
data
callback
Since:
  • 2.0.0 (stability: committed)

watchIndexes(watchList, options, callback)

Watches a list of indexes; waiting for them to become available for use.

Parameters:
Name Type Description
watchList
options
Properties
Name Type Description
timeout

Timeout in millseconds

callback
Since:
  • 2.1.6 (stability: committed)