Thanks to visit codestin.com
Credit goes to docs.couchbase.com

Class CollectionManager

CollectionManager allows the management of collections within a Bucket.

Index

Methods

createScope dropCollection dropScope getAllScopes updateCollection

Methods

createScope

createScope(
    scopeName: string,
    options?: CreateScopeOptions,
    callback?: NodeCallback<void>,
): Promise<void>
Creates a new scope.
Parameters
- scopeName: string
  The name of the new scope to create.
- Optionaloptions: CreateScopeOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/collectionmanager.ts:521

dropCollection

dropCollection(
    collectionName: string,
    scopeName: string,
    options?: DropCollectionOptions,
    callback?: NodeCallback<void>,
): Promise<void>
Drops a collection from a scope.
Parameters
- collectionName: string
  The name of the collection to drop.
- scopeName: string
  The name of the scope containing the collection to drop.
- Optionaloptions: DropCollectionOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/collectionmanager.ts:429

dropScope

dropScope(
    scopeName: string,
    options?: DropScopeOptions,
    callback?: NodeCallback<void>,
): Promise<void>
Drops a scope.
Parameters
- scopeName: string
  The name of the scope to drop.
- Optionaloptions: DropScopeOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/collectionmanager.ts:563

getAllScopes

getAllScopes(
options?: GetAllScopesOptions,
callback?: NodeCallback<ScopeSpec[]>,
): Promise<ScopeSpec[]>
Returns all configured scopes along with their collections.
Parameters
- Optionaloptions: GetAllScopesOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<ScopeSpec[]>
  A node-style callback to be invoked after execution.
Returns Promise<ScopeSpec[]>
- Defined in lib/collectionmanager.ts:273

updateCollection

updateCollection(
    collectionName: string,
    scopeName: string,
    settings: UpdateCollectionSettings,
    options?: UpdateCollectionOptions,
    callback?: NodeCallback<void>,
): Promise<void>
Updates a collection in a scope.
Parameters
- collectionName: string
  The name of the collection to update.
- scopeName: string
  The name of the scope containing the collection.
- settings: UpdateCollectionSettings
  The settings to update on the collection.
- Optionaloptions: UpdateCollectionOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/collectionmanager.ts:475