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

createIndex

createIndex(
    indexName: string,
    keys: string[],
    options?: CreateQueryIndexOptions,
    callback?: NodeCallback<void>,
): 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.
- Optionaloptions: CreateQueryIndexOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/queryindexmanager.ts:608

createPrimaryIndex

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

dropIndex

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

dropPrimaryIndex

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

getAllIndexes

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

watchIndexes

watchIndexes(
    indexNames: string[],
    timeout: number,
    options?: WatchQueryIndexOptions,
    callback?: NodeCallback<void>,
): 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.
- Optionaloptions: WatchQueryIndexOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/queryindexmanager.ts:804