Class QueryIndex

Contains a specific index configuration for the query service.


  • QueryIndex


bucketName?: string

The bucket that this index is for.

collectionName?: string

The collection that this index is for.

condition?: string

The conditional expression to limit the indexes scope.

indexKey: string[]

The keys for this index.

isPrimary: boolean

Whether this is a primary or secondary index.

name: string

The name of the index.

partition?: string

Information about the partitioning of this index.

scopeName?: string

The scope that this index is for.

state: string

The current state of the index.

type: string

The type of index.

Generated using TypeDoc