REST Resource: projects.databases.collectionGroups.indexes

Ressource: Index

Cloud Firestore-Indizes ermöglichen einfache und komplexe Abfragen von Dokumenten in einer Datenbank.

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

string

Nur Ausgabe. Ein vom Server definierter Name für diesen Index. Die Form dieses Namens für zusammengesetzte Indizes lautet: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id} Bei Einzelfeldindizes ist dieses Feld leer.

queryScope

enum ( QueryScope )

Indizes mit einem angegebenen Sammlungsabfragebereich ermöglichen Abfragen für eine Sammlung, die das untergeordnete Element eines bestimmten Dokuments ist, zum Zeitpunkt der Abfrage angegeben wurde und dieselbe Sammlungs-ID hat.

Indizes mit einem angegebenen Sammlungsgruppen-Abfragebereich ermöglichen Abfragen für alle Sammlungen, die von einem bestimmten Dokument abstammen, das zum Zeitpunkt der Abfrage angegeben wurde und dieselbe Sammlungs-ID wie dieser Index haben.

apiScope

enum ( ApiScope )

Der von diesem Index unterstützte API-Bereich.

fields[]

object ( IndexField )

Die von diesem Index unterstützten Felder.

Für zusammengesetzte Indizes sind hierfür mindestens 2 und maximal 100 Felder erforderlich. Der letzte Feldeintrag gilt immer für den Feldpfad __name__ . Wenn bei der Erstellung __name__ nicht als letztes Feld angegeben wurde, wird es automatisch in derselben Richtung wie das zuletzt definierte Feld hinzugefügt. Wenn das letzte Feld in einem zusammengesetzten Index nicht gerichtet ist, wird __name__ aufsteigend sortiert (sofern nicht ausdrücklich angegeben).

Bei Einzelfeldindizes ist dies immer genau ein Eintrag mit einem Feldpfad, der dem Feldpfad des zugehörigen Felds entspricht.

state

enum ( State )

Nur Ausgabe. Der Bereitstellungsstatus des Index.

Methoden

create

Erstellt einen zusammengesetzten Index.

delete

Löscht einen zusammengesetzten Index.

get

Ruft einen zusammengesetzten Index ab.

list

Listet zusammengesetzte Indizes auf.