REST Resource: projects.databases.indexes

Zasób: Indeks

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 ten indeks. Wymagane.
fields[]

object (IndexField)

Pola do indeksowania.
state

enum (State)

Stan indeksu. Tylko dane wyjściowe.

IndexField

Pole indeksu.

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

string

Ścieżka pola. Musi być zgodny ze specyfikacją ścieżki pola opisaną w [google.firestore.v1beta1.Document.fields][fields]. Specjalnej ścieżki pola __name__ można użyć samodzielnie lub na końcu ścieżki. Typu __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 Nie określono trybu.
ASCENDING Wartości pola są indeksowane w taki sposób, aby można było obsługiwać sekwencjonowanie w kolejności rosnącej, a także zapytania za pomocą znaków <, >, <=, >= oraz =.
DESCENDING Wartości pola są indeksowane w taki sposób, aby można było obsługiwać sekwencjonowanie w kolejności malejącej, a także zapytania za pomocą znaków <, >, <=, >= oraz =.
ARRAY_CONTAINS Wartości w tablicy pola są indeksowane w sposób umożliwiający obsługę członkostwa za pomocą zapytań ARRAY_CONTAINS.

Stan

Stan indeksu. Podczas tworzenia indeksu będzie on miał stan CREATING. Jeśli indeks zostanie utworzony, przejdzie do stanu READY. Jeśli nie można 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 pisania dokumentu. Mogą istnieć dane indeksu.
READY Indeks jest gotowy do użycia. Indeks jest aktualizowany podczas pisania dokumentu. Indeks jest w pełni wypełniany ze wszystkich przechowywanych dokumentów, do których ma zastosowanie.
ERROR Tworzę indeks, ale coś poszło nie tak. Nie ma żadnej aktywnej długo trwającej operacji, a ostatnia zakończona długotrwała operacja zakończyła się niepowodzeniem. Indeks nie jest aktualizowany podczas pisania dokumentu. Mogą istnieć dane indeksu.

Metody

create

 Tworzy określony indeks.

delete

 Usuwa indeks.

get

 Pobiera indeks.

list

 Wyświetla listę indeksów, które pasują do określonych filtrów.