Ressource: Index
Eine Indexdefinition.
JSON-Darstellung |
---|
{ "name": string, "collectionId": string, "fields": [ { object ( |
Felder | |
---|---|
name | Der Ressourcenname des Index. Nur Ausgabe. |
collectionId | Die Sammlungs-ID, für die dieser Index gilt. Erforderlich. |
fields[] | Die zu indizierenden Felder. |
state | Der Status des Index. Nur Ausgabe. |
IndexField
Ein Feld eines Index.
JSON-Darstellung |
---|
{
"fieldPath": string,
"mode": enum ( |
Felder | |
---|---|
fieldPath | Der Weg des Feldes. Muss mit der in [google.firestore.v1beta1.Document.fields][fields] beschriebenen Feldpfadspezifikation übereinstimmen. Der spezielle Feldpfad |
mode | Der Modus des Feldes. |
Modus
Der Modus bestimmt, wie ein Feld indiziert wird.
Aufzählungen | |
---|---|
MODE_UNSPECIFIED | Der Modus ist nicht spezifiziert. |
ASCENDING | Die Werte des Feldes werden indiziert, um die Reihenfolge in aufsteigender Reihenfolge und die Abfrage nach <, >, <=, >= und = zu unterstützen. |
DESCENDING | Die Werte des Feldes werden indiziert, um die Reihenfolge in absteigender Reihenfolge und auch die Abfrage nach <, >, <=, >= und = zu unterstützen. |
ARRAY_CONTAINS | Die Array-Werte des Felds werden indiziert, um die Mitgliedschaft mithilfe von ARRAY_CONTAINS-Abfragen zu unterstützen. |
Zustand
Der Status eines Index. Während der Indexerstellung befindet sich ein Index im Status CREATING
. Wenn der Index erfolgreich erstellt wurde, wechselt er in den Status READY
. Wenn der Index nicht erstellt werden kann, wechselt er in den Status ERROR
.
Aufzählungen | |
---|---|
STATE_UNSPECIFIED | Der Staat ist nicht spezifiziert. |
CREATING | Der Index wird erstellt. Für den Index ist ein aktiver, lang andauernder Vorgang vorhanden. Der Index wird beim Schreiben eines Dokuments aktualisiert. Möglicherweise sind einige Indexdaten vorhanden. |
READY | Der Index ist einsatzbereit. Der Index wird beim Schreiben eines Dokuments aktualisiert. Der Index wird vollständig mit allen gespeicherten Dokumenten gefüllt, auf die er sich bezieht. |
ERROR | Der Index wurde erstellt, aber es ist ein Fehler aufgetreten. Für den Index ist kein aktiver Langzeitvorgang vorhanden und der zuletzt abgeschlossene Langzeitvorgang ist fehlgeschlagen. Der Index wird beim Schreiben eines Dokuments nicht aktualisiert. Möglicherweise sind einige Indexdaten vorhanden. |
Methoden | |
---|---|
| Erstellt den angegebenen Index. |
| Löscht einen Index. |
| Ruft einen Index ab. |
| Listet die Indizes auf, die den angegebenen Filtern entsprechen. |