IndexConfiguration interface

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Instead of creating cache indexes manually, consider using enablePersistentCacheIndexAutoCreation() to let the SDK decide whether to create cache indexes for queries running locally.

A list of Firestore indexes to speed up local query execution.

See JSON Format for a description of the format of the index definition.

Signature:

export declare interface IndexConfiguration 

Properties

IndexConfiguration.indexes

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

A list of all Firestore indexes.

Signature:

readonly indexes?: Index[];