Class CollectionQueryIndexManager

CollectionQueryIndexManager provides an interface for managing the query indexes on the collection.

Index

Methods

buildDeferredIndexes createIndex createPrimaryIndex dropIndex dropPrimaryIndex getAllIndexes watchIndexes

Methods

buildDeferredIndexes

buildDeferredIndexes(options?, callback?): Promise<string[]>
Starts building any indexes which were previously created with deferred=true.
Parameters
- Optional options: BuildQueryIndexOptions
  Optional parameters for this operation.
- Optional callback: NodeCallback<string[]>
  A node-style callback to be invoked after execution.
Returns Promise<string[]>
- Defined in lib/queryindexmanager.ts:773

createIndex

createIndex(indexName, keys, options?, callback?): Promise<void>
Creates a new query index.
Parameters
- indexName: string
  The name of the new index.
- keys: string[]
  The keys which this index should cover.
- Optional options: CreateQueryIndexOptions
  Optional parameters for this operation.
- Optional callback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/queryindexmanager.ts:608

createPrimaryIndex

createPrimaryIndex(options?, callback?): Promise<void>
Creates a new primary query index.
Parameters
- Optional options: CreatePrimaryQueryIndexOptions
  Optional parameters for this operation.
- Optional callback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/queryindexmanager.ts:645

dropIndex

dropIndex(indexName, options?, callback?): Promise<void>
Drops an existing query index.
Parameters
- indexName: string
  The name of the index to drop.
- Optional options: DropQueryIndexOptions
  Optional parameters for this operation.
- Optional callback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/queryindexmanager.ts:679

dropPrimaryIndex

dropPrimaryIndex(options?, callback?): Promise<void>
Drops an existing primary index.
Parameters
- Optional options: DropPrimaryQueryIndexOptions
  Optional parameters for this operation.
- Optional callback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/queryindexmanager.ts:712

getAllIndexes

getAllIndexes(options?, callback?): Promise<QueryIndex[]>
Returns a list of indexes for a specific bucket.
Parameters
- Optional options: GetAllQueryIndexesOptions
  Optional parameters for this operation.
- Optional callback: NodeCallback<QueryIndex[]>
  A node-style callback to be invoked after execution.
Returns Promise<QueryIndex[]>
- Defined in lib/queryindexmanager.ts:744

watchIndexes

watchIndexes(indexNames, timeout, options?, callback?): Promise<void>
Waits for a number of indexes to finish creation and be ready to use.
Parameters
- indexNames: string[]
  The names of the indexes to watch.
- timeout: number
  The maximum time to wait for the index, expressed in milliseconds.
- Optional options: WatchQueryIndexOptions
  Optional parameters for this operation.
- Optional callback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/queryindexmanager.ts:804