CollectionManager | couchbase

CollectionManager allows the management of collections within a Bucket.

Hierarchy

CollectionManager

Index

Methods

createCollection

createCollection(collectionName: string, scopeName: string, options?: CreateCollectionOptions, callback?: NodeCallback<void>): Promise<void>
createCollection(collectionSpec: ICollectionSpec, options?: CreateCollectionOptions, callback?: NodeCallback<void>): Promise<void>

- Defined in lib/collectionmanager.ts:289
Creates a collection in a scope.

deprecated

Use the other overload instead.

Parameters
- collectionName: string
- scopeName: string
- Optional options: CreateCollectionOptions
- Optional callback: NodeCallback<void>
Returns Promise<void>
- Defined in lib/collectionmanager.ts:303
Creates a collection in a scope.

Parameters
- collectionSpec: ICollectionSpec
  
  Specifies the settings for the new 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: string, options?: CreateScopeOptions, callback?: NodeCallback<void>): Promise<void>

- Defined in lib/collectionmanager.ts:445
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: string, scopeName: string, options?: DropCollectionOptions, callback?: NodeCallback<void>): Promise<void>

- Defined in lib/collectionmanager.ts:389
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: string, options?: DropScopeOptions, callback?: NodeCallback<void>): Promise<void>

- Defined in lib/collectionmanager.ts:501
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?: GetAllScopesOptions, callback?: NodeCallback<ScopeSpec[]>): Promise<ScopeSpec[]>

- Defined in lib/collectionmanager.ts:237
Returns all configured scopes along with their collections.

Parameters
- Optional options: GetAllScopesOptions
  
  Optional parameters for this operation.
- Optional callback: NodeCallback<ScopeSpec[]>
  
  A node-style callback to be invoked after execution.
Returns Promise<ScopeSpec[]>

Hierarchy

Index

Methods

Methods

createCollection

Parameters

collectionName: string

scopeName: string

Optional options: CreateCollectionOptions

Optional callback: NodeCallback<void>

Returns Promise<void>

Parameters

collectionSpec: ICollectionSpec

Optional options: CreateCollectionOptions

Optional callback: NodeCallback<void>

Returns Promise<void>

createScope

Parameters

scopeName: string

Optional options: CreateScopeOptions

Optional callback: NodeCallback<void>

Returns Promise<void>

dropCollection

Parameters

collectionName: string

scopeName: string

Optional options: DropCollectionOptions

Optional callback: NodeCallback<void>

Returns Promise<void>

dropScope

Parameters

scopeName: string

Optional options: DropScopeOptions

Optional callback: NodeCallback<void>

Returns Promise<void>

getAllScopes

Parameters

Optional options: GetAllScopesOptions

Optional callback: NodeCallback<ScopeSpec[]>

Returns Promise<ScopeSpec[]>