REST Resource: projects.databases.collectionGroups.indexes

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

string

Tylko dane wyjściowe. Zdefiniowana przez serwer nazwa tego indeksu. Ta nazwa indeksów złożonych będzie miała postać: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id} W przypadku indeksów pojedynczych pól to pole będzie puste.

enum (QueryScope)

Indeksy o określonym zakresie zapytania kolekcji umożliwiają wysyłanie zapytań do kolekcji, która jest podrzędna względem określonego dokumentu, określona w czasie wykonywania zapytania i o tym samym identyfikatorze kolekcji.

Indeksy z określonym zakresem zapytania grupy kolekcji zezwalają na wysyłanie zapytań do wszystkich kolekcji pochodzących z określonego dokumentu, określonych w czasie wykonywania zapytania i mających ten sam identyfikator kolekcji co ten indeks.

object (IndexField)

Pola obsługiwane przez ten indeks.

W przypadku indeksów złożonych są to zawsze co najmniej 2 pola. Ostatni wpis w polu zawsze dotyczy ścieżki pola __name__. Jeśli podczas tworzenia pola __name__ nie zostało określone jako ostatnie pole, zostanie ono dodane automatycznie z tym samym kierunkiem co ostatnie zdefiniowane pole. Jeśli ostatnie pole indeksu złożonego nie jest kierunkowe, pole __name__ ma kolejność ASCENDING (chyba że wyraźnie określono inaczej).

W przypadku indeksów pojedynczych pól będzie to zawsze dokładnie 1 wpis ze ścieżką pola równą ścieżce powiązanego pola.

enum (State)

Tylko dane wyjściowe. Stan obsługi indeksu.