REST Resource: projects.databases.indexes

Ressource: Index

Eine Indexdefinition.

JSON-Darstellung
{
  "name": string,
  "collectionId": string,
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
Felder
name

string

Der Ressourcenname des Index. Nur Ausgabe.

collectionId

string

Die Sammlungs-ID, für die dieser Index gilt. Erforderlich.

fields[]

object ( IndexField )

Die zu indizierenden Felder.

state

enum ( State )

Der Status des Index. Nur Ausgabe.

IndexField

Ein Feld eines Index.

JSON-Darstellung
{
  "fieldPath": string,
  "mode": enum (Mode)
}
Felder
fieldPath

string

Der Weg des Feldes. Muss mit der in [google.firestore.v1beta1.Document.fields][fields] beschriebenen Feldpfadspezifikation übereinstimmen. Der spezielle Feldpfad __name__ kann einzeln oder am Ende eines Pfads verwendet werden. __type__ darf nur am Ende des Pfads verwendet werden.

mode

enum ( 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

create

Erstellt den angegebenen Index.

delete

Löscht einen Index.

get

Ruft einen Index ab.

list

Listet die Indizes auf, die den angegebenen Filtern entsprechen.