Class CollectionQueryIndexManager

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

Hierarchy

  • CollectionQueryIndexManager

Methods

buildDeferredIndexes createIndex createPrimaryIndex dropIndex dropPrimaryIndex getAllIndexes watchIndexes

Methods

buildDeferredIndexes

  • 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[]>

createIndex

  • 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>

createPrimaryIndex

  • Creates a new primary query index.

    Parameters

    Returns Promise<void>

dropIndex

  • 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>

dropPrimaryIndex

  • Drops an existing primary index.

    Parameters

    Returns Promise<void>

getAllIndexes

  • Returns a list of indexes for a specific bucket.

    Parameters

    Returns Promise<QueryIndex[]>

watchIndexes

  • 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>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc