Class CollectionManager

CollectionManager allows the management of collections within a Bucket.

Methods

createCollection createScope dropCollection dropScope getAllScopes updateCollection

Methods

createCollection

  • createCollection(collectionSpec, options?, callback?): Promise<void>

  • Creates a collection in a scope.

    Parameters

    Returns Promise<void>

    Deprecated

    Use the other overload instead.

  • createCollection(collectionName, scopeName, options?, callback?): Promise<void>

  • Creates a collection in a scope.

    Parameters

    Returns Promise<void>

  • createCollection(collectionName, scopeName, settings?, options?, callback?): Promise<void>

  • Creates a collection in a scope.

    Parameters

    • collectionName: string

      The name of the collection.

    • scopeName: string

      The name of the scope containing this collection.

    • Optional settings: CreateCollectionSettings

      The settings to use on creating the collection.

    • Optional options: CreateCollectionOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

createScope

  • createScope(scopeName, options?, callback?): Promise<void>

  • Creates a new scope.

    Parameters

    • scopeName: string

      The name of the new scope to create.

    • Optional options: CreateScopeOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

dropCollection

  • dropCollection(collectionName, scopeName, options?, callback?): 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.

    • Optional options: DropCollectionOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

dropScope

  • dropScope(scopeName, options?, callback?): Promise<void>

  • Drops a scope.

    Parameters

    • scopeName: string

      The name of the scope to drop.

    • Optional options: DropScopeOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

getAllScopes

  • getAllScopes(options?, callback?): Promise<ScopeSpec[]>

  • Returns all configured scopes along with their collections.

    Parameters

    Returns Promise<ScopeSpec[]>

updateCollection

  • updateCollection(collectionName, scopeName, settings, options?, callback?): 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.

    • Optional options: UpdateCollectionOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

createCollectioncreateScopedropCollectiondropScopegetAllScopesupdateCollection