REST Resource: projects.databases.collectionGroups.indexes

{
  "name": string,
  "queryScope": enum (QueryScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}

string

Nur Ausgabe Ein vom Server definierter Name für diesen Index. Das Format dieses Namens für zusammengesetzte Indexe sieht so aus: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id}. Bei Einzelfeldindexen ist dieses Feld leer.

enum (QueryScope)

Indexe, für die ein Sammlungsabfragebereich angegeben ist, ermöglichen Abfragen für eine Sammlung, die einem bestimmten Dokument untergeordnet ist, zum Zeitpunkt der Abfrage angegeben wurde und dieselbe Sammlungs-ID hat.

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

object (IndexField)

Die von diesem Index unterstützten Felder.

Bei zusammengesetzten Indexen sind dies immer 2 oder mehr Felder. Der letzte Feldeintrag bezieht sich immer auf den Feldpfad __name__. Wenn __name__ beim Erstellen nicht als letztes Feld angegeben wurde, wird es automatisch mit derselben Richtung wie das zuletzt definierte Feld hinzugefügt. Wenn das letzte Feld in einem zusammengesetzten Index nicht direktional ist, wird __name__ in aufsteigender Reihenfolge sortiert (sofern nicht ausdrücklich angegeben).

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

enum (State)

Nur Ausgabe Der Bereitstellungsstatus des Index.