REST Resource: projects.databases.indexes

Zasób: Index

Definicja indeksu.

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

string

Nazwa zasobu indeksu. Tylko dane wyjściowe.
collectionId

string

Identyfikator kolekcji, do której ma zastosowanie dany indeks. Wymagane.
fields[]

object (IndexField)

Pola do indeksowania.
state

enum (State)

Stan indeksu. Tylko dane wyjściowe.

Pole indeksu

Pole indeksu.

Zapis JSON 
{
  "fieldPath": string,
  "mode": enum (Mode)
}
Pola
fieldPath

string

Ścieżka pola. Musi być zgodna ze specyfikacją ścieżki pola opisaną przez [google.firestore.v1beta1.Document.fields][fields]. Ścieżka pola specjalnego __name__ może być używana samodzielnie lub na końcu ścieżki. __type__ można użyć tylko na końcu ścieżki.
mode

enum (Mode)

Tryb pola.

Tryb

Tryb określa sposób indeksowania pola.

Wartości w polu enum
MODE_UNSPECIFIED Tryb nie jest określony.
ASCENDING Wartości pola są indeksowane w taki sposób, by obsługiwać sekwencjonowanie w kolejności rosnącej oraz zapytania według znaków <, >, <=, >= i =.
DESCENDING Wartości pola są indeksowane w sposób umożliwiający obsługę sekwencjonowania w porządku malejącym oraz wykonywanie zapytań według znaków <, >, <=, >= i =.
ARRAY_CONTAINS Wartości tablicowe pola są indeksowane, aby umożliwić obsługę członkostwa za pomocą zapytań ARRAY_CONTAINS.

Stan

Stan indeksu. Podczas tworzenia indeksu indeks będzie miał stan CREATING. Jeśli indeks zostanie utworzony, przejdzie do stanu READY. Jeśli nie uda się utworzyć indeksu, przejdzie on do stanu ERROR.

Wartości w polu enum
STATE_UNSPECIFIED Stan nie jest określony.
CREATING Tworzę indeks. Istnieje aktywna długo trwająca operacja dla indeksu. Indeks jest aktualizowany podczas tworzenia dokumentu. Niektóre dane indeksu mogą istnieć.
READY Indeks jest gotowy do użycia. Indeks jest aktualizowany podczas tworzenia dokumentu. Indeks jest w pełni wypełniany ze wszystkich zapisanych dokumentów, których dotyczy.
ERROR Trwa tworzenie indeksu, ale coś poszło nie tak. Nie ma żadnej aktywnej długo trwającej operacji dla indeksu, a ostatnia zakończona długo trwająca operacja zakończyła się niepowodzeniem. Indeks nie jest aktualizowany podczas tworzenia dokumentu. Niektóre dane indeksu mogą istnieć.

Metody

create

 Tworzy określony indeks.

delete

 Usuwa indeks.

get

 Pobiera indeks.

list

 Zawiera listę indeksów pasujących do określonych filtrów.