Class

CollectionManager

CollectionManager

CollectionManager allows the management of collections within a Bucket.

Methods

# async createCollection(collectionSpec, optionsopt, callbackopt) → {Promise.<boolean>}

createCollection creates a collection within a scope in a bucket.

Parameters:
Name Type Attributes Description
collectionSpec CollectionSpec

The details of the collection to create.

options Object <optional>
timeout Number <optional>

Timeout for the operation in milliseconds.

callback CreateCollectionCallback <optional>

View Source collectionmanager.js, line 52

Promise.<boolean>

# async createScope(scopeName, optionsopt, callbackopt) → {Promise.<boolean>}

createScope creates a scope within a bucket.

Parameters:
Name Type Attributes Description
scopeName string

The name of the scope to create.

options Object <optional>
timeout Number <optional>

Timeout for the operation in milliseconds.

callback CreateScopeCallback <optional>

View Source collectionmanager.js, line 178

Promise.<boolean>

# async dropCollection(collectionName, scopeName, optionsopt, callbackopt) → {Promise.<boolean>}

dropCollection drops a collection from a scope in a bucket.

Parameters:
Name Type Attributes Description
collectionName string

The name of the collection to drop.

scopeName string

The name of the scope containing the collection to drop.

options Object <optional>
timeout Number <optional>

Timeout for the operation in milliseconds.

callback DropCollectionCallback <optional>

View Source collectionmanager.js, line 127

Promise.<boolean>

# async dropScope(scopeName, optionsopt, callbackopt) → {Promise.<boolean>}

dropScope drops a scope from a bucket.

Parameters:
Name Type Attributes Description
scopeName string

The name of the scope to drop.

options Object <optional>
timeout Number <optional>

Timeout for the operation in milliseconds.

callback DropScopeCallback <optional>

View Source collectionmanager.js, line 234

Promise.<boolean>