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 indexierenden Felder.
state

enum (State)

Der Status des Index. Nur Ausgabe

IndexField

Feld eines Index.

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

string

Der Pfad des Felds. Muss mit der Spezifikation des Feldpfads übereinstimmen, die in [google.firestore.v1beta1.Document.fields][fields] beschrieben wird. Der spezielle Feldpfad __name__ kann allein oder am Ende eines Pfads verwendet werden. __type__ darf nur am Ende des Pfads verwendet werden.
mode

enum (Mode)

Der Modus des Felds.

Modus

Der Modus bestimmt, wie ein Feld indexiert wird.

Enums
MODE_UNSPECIFIED Der Modus ist nicht angegeben.
ASCENDING Die Werte des Felds sind indexiert, um eine Sequenzierung in aufsteigender Reihenfolge und eine Abfrage nach <, >, <=, >= und = zu unterstützen.
DESCENDING Die Feldwerte sind indexiert, um eine Sequenzierung in absteigender Reihenfolge zu unterstützen und auch Abfragen nach <, >, <=, >= und = zu ermöglichen.
ARRAY_CONTAINS Die Arraywerte des Feldes sind indexiert, um die Mitgliedschaft bei ARRAY_CONTAINS-Abfragen zu unterstützen.

Status

Der Status eines Index. Während der Indexerstellung hat ein Index den 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.

Enums
STATE_UNSPECIFIED Der Status ist nicht angegeben.
CREATING Der Index wird erstellt. Für den Index ist ein aktiver Vorgang mit langer Ausführungszeit vorhanden. Der Index wird beim Schreiben eines Dokuments aktualisiert. Möglicherweise sind einige Indexdaten vorhanden.
READY Der Index kann verwendet werden. Der Index wird beim Schreiben eines Dokuments aktualisiert. Der Index ist vollständig mit allen gespeicherten Dokumenten gefüllt, für die er gilt.
ERROR Der Index wurde erstellt, aber ein Fehler ist aufgetreten. Für den Index ist kein aktiver Vorgang mit langer Ausführungszeit vorhanden und der zuletzt abgeschlossene Vorgang mit langer Ausführungszeit 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 Indexe auf, die den angegebenen Filtern entsprechen.