Reference documentation and code samples for the Firestore Admin v1 API enum Index.Types.State.
The state of an index. During index creation, an index will be in the
CREATING state. If the index is created successfully, it will transition
to the READY state. If the index creation encounters a problem, the index
will transition to the NEEDS_REPAIR state.
The index is being created.
There is an active long-running operation for the index.
The index is updated when writing a document.
Some index data may exist.
NeedsRepair
The index was being created, but something went wrong.
There is no active long-running operation for the index,
and the most recently finished long-running operation failed.
The index is not updated when writing a document.
Some index data may exist.
Use the google.longrunning.Operations API to determine why the operation
that last attempted to create this index failed, then re-create the
index.
Ready
The index is ready to be used.
The index is updated when writing a document.
The index is fully populated from all stored documents it applies to.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-04 UTC."],[[["This documentation covers the `Index.Types.State` enum within the Firestore Admin v1 API, providing information on the different states an index can be in."],["The `Index.Types.State` enum can represent four states: `Creating`, `NeedsRepair`, `Ready`, and `Unspecified`, each indicating the status and usability of the index."],["The `Creating` state signifies that an index is in the process of being built, and some index data may exist."],["The `NeedsRepair` state indicates that the index creation process failed, the index is not updated, and no active operation exists, and the `Ready` state signifies the index is fully functional."],["The latest documented version for the index types state is version 3.12.0 and there are multiple other versions all the way down to 2.2.0."]]],[]]
