Class QueryIndex

Contains a specific index configuration for the query service.

Properties

bucketName? collectionName? condition? indexKey isPrimary name partition? scopeName? state type

Properties

Optional bucketName

bucketName?: string

The bucket that this index is for.

Optional collectionName

collectionName?: string

The collection that this index is for.

Optional condition

condition?: string

The conditional expression to limit the indexes scope.

indexKey

indexKey: string[]

The keys for this index.

isPrimary

isPrimary: boolean

Whether this is a primary or secondary index.

name

name: string

The name of the index.

Optional partition

partition?: string

Information about the partitioning of this index.

Optional scopeName

scopeName?: string

The scope that this index is for.

state

state: string

The current state of the index.

type

type: string

The type of index.

Settings

Member Visibility

Theme

On This Page

bucketNamecollectionNameconditionindexKeyisPrimarynamepartitionscopeNamestatetype