Stay organized with collections
Save and categorize content based on your preferences.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-27 UTC."],[],[],null,["# IndexConfiguration interface\n\n\u003e 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.\n\u003e | **Warning:** This API is now obsolete.\n\u003e\n\u003e Instead of creating cache indexes manually, consider using `enablePersistentCacheIndexAutoCreation()` to let the SDK decide whether to create cache indexes for queries running locally.\n\nA list of Firestore indexes to speed up local query execution.\n\nSee [JSON Format](https://firebase.google.com/docs/reference/firestore/indexes/#json_format) for a description of the format of the index definition.\n\n**Signature:** \n\n export declare interface IndexConfiguration \n\nProperties\n----------\n\n| Property | Type | Description |\n|-------------------------------------------------------------------------|----------------------------------------------------|---------------------------------------------------------|\n| [indexes](./firestore_.indexconfiguration.md#indexconfigurationindexes) | [Index](./firestore_.index.md#index_interface)\\[\\] | ***(Public Preview)*** A list of all Firestore indexes. |\n\nIndexConfiguration.indexes\n--------------------------\n\n\u003e 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.\n\nA list of all Firestore indexes.\n\n**Signature:** \n\n readonly indexes?: Index[];"]]