REST Resource: projects.databases.collectionGroups.indexes

Zasób: Index

Indeksy Cloud Firestore umożliwiają proste i złożone zapytania dotyczące dokumentów w bazie danych.

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

string

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

enum (QueryScope)

Indeksy z określonym zakresem zapytań do kolekcji umożliwiają wykonywanie zapytań na zbiorze podrzędnym określonego dokumentu, określonym w czasie wykonywania zapytania i o tym samym identyfikatorze kolekcji.

Indeksy z określonym zakresem zapytań dotyczącym grupy kolekcji zezwalają na wykonywanie zapytań dotyczących wszystkich kolekcji pochodzących z określonego dokumentu, określonych w czasie wykonywania zapytania i mających ten sam identyfikator kolekcji co ten indeks.
fields[]

object (IndexField)

Pola obsługiwane przez ten indeks.

W przypadku indeksów złożonych jest to zawsze co najmniej 2 pola. Ostatni wpis w polu dotyczy zawsze ścieżki pola __name__. Jeśli podczas tworzenia pole __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 w indeksie złożonym nie jest kierunkowe, pole __name__ zostanie uporządkowane ASCENDING (chyba że wyraźnie określono inaczej).

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

enum (State)

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

Metody

create

 Tworzy indeks złożony.

delete

 Usuwa indeks złożony.

get

 Pobiera indeks złożony.

list

 Wyświetla listę indeksów złożonych.