Package google.firestore.admin.v1beta1

Indeks

Administrator Firestore

Interfejs Cloud Firestore Admin API.

Ten interfejs API udostępnia kilka usług administracyjnych w Cloud Firestore.

Pojęcia

Projekty, baza danych, przestrzeń nazw, kolekcja i dokument są używane zgodnie z definicją interfejsu Google Cloud Firestore API.

Operacja: operacja oznacza pracę wykonywaną w tle.

Usługi

Indeks

Usługa indeksu zarządza indeksami Cloud Firestore.

Tworzenie indeksu jest wykonywane asynchronicznie. Dla każdej takiej operacji asynchronicznej tworzony jest zasób operacji. Zapytanie o stan operacji (w tym o wszelkie napotkane błędy) może zostać wysłane za pomocą zasobu operacji.

Metadane

Udostępnia metadane i informacje statystyczne dotyczące danych w Cloud Firestore. Dane dostarczone w ramach tego interfejsu API mogą być nieaktualne.

Operacja

Kolekcja Operacje zawiera rejestr działań wykonanych w danym projekcie (w tym trwające operacje). Operacje nie są tworzone bezpośrednio, lecz przez wywołania innych kolekcji lub zasobów.

Niezakończona operacja może zostać anulowana. Żądanie anulowania jest asynchroniczne, a operacja może być kontynuowana przez pewien czas po przesłaniu takiego żądania.

Wykonana operacja może zostać usunięta, tak aby nie była już wymieniona w kolekcji operacji.

Operacje są tworzone przez usługę FirestoreAdmin, ale dostęp do nich uzyskuje się przez usługę google.longrunning.Operations.

Utwórz indeks

rpc CreateIndex(CreateIndexRequest) returns (Operation)

Tworzy określony indeks. Początkowy stan nowo utworzonego indeksu to CREATING. Po zakończeniu zwróconego kodu google.longrunning.Operation stan zmieni się na READY. Jeśli indeks już istnieje, wywołanie zwróci stan ALREADY_EXISTS.

Podczas tworzenia proces może spowodować błąd. W takim przypadku indeks zostanie przeniesiony do stanu ERROR. Ten proces można przywrócić, naprawiając dane, które spowodowały błąd, usuwając indeks przy użyciu metody delete, a następnie ponownie tworząc indeks za pomocą metody create.

Nie można tworzyć indeksów z jednym polem.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).
Usuń indeks

rpc DeleteIndex(DeleteIndexRequest) returns (Empty)

Usuwa indeks.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).
ExportDocuments

rpc ExportDocuments(ExportDocumentsRequest) returns (Operation)

Eksportuje kopię wszystkich lub niektórych dokumentów z Google Cloud Firestore do innego systemu pamięci masowej, na przykład Google Cloud Storage. Ostatnie zmiany w dokumentach mogą nie zostać uwzględnione w eksporcie. Eksport odbywa się w tle, a jego postęp można monitorować i zarządzać nim za pomocą tworzonego zasobu operacji. Danych wyjściowych eksportu można użyć dopiero po zakończeniu powiązanej operacji. Jeśli operacja eksportu zostanie anulowana przed ukończeniem, może pozostawić w Google Cloud Storage częściowe dane.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).
GetIndex

rpc GetIndex(GetIndexRequest) returns (Index)

Pobiera indeks.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).
ImportDocuments

rpc ImportDocuments(ImportDocumentsRequest) returns (Operation)

Importuje dokumenty do Google Cloud Firestore. Istniejące dokumenty o takiej samej nazwie zostaną zastąpione. Import odbywa się w tle, a jego postęp może być monitorowany i można nim zarządzać za pomocą tworzonego zasobu operacji. Jeśli operacja ImportDocuments zostanie anulowana, podzbiór danych może zostać już zaimportowany do Cloud Firestore.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).
Wyświetlanie listy indeksów

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

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

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).

Tworzenie żądania indeksu

Prośba dotycząca usługi FirestoreAdmin.CreateIndex.

Pola
parent

string

Nazwa bazy danych, do której będzie mieć zastosowanie ten indeks. Na przykład: projects/{project_id}/databases/{database_id}
index

Index

Indeks do utworzenia. Pola nazwy i stanu są tylko danymi wyjściowymi i będą ignorowane. Niektórych indeksów z pojedynczym polem nie można tworzyć ani usuwać.

DeleteIndexRequest

Prośba dotycząca usługi FirestoreAdmin.DeleteIndex.

Pola
name

string

Nazwa indeksu. Na przykład: projects/{project_id}/databases/{database_id}/indexes/{index_id}

ExportDocumentsMetadata

Metadane operacji ExportDocuments.

Pola
start_time

Timestamp

Godzina rozpoczęcia pracy nad operację.
end_time

Timestamp

Czas zakończenia operacji (pomyślnie lub inaczej). Nie ustawiaj tego ustawienia, jeśli operacja jest nadal aktywna.
operation_state

OperationState

Stan operacji eksportu.
progress_documents

Progress

Szacunkowa liczba przetworzonych dokumentów.
progress_bytes

Progress

Szacowana liczba przetworzonych bajtów.
collection_ids[]

string

Które identyfikatory kolekcji są eksportowane.
output_uri_prefix

string

Miejsce, do którego są eksportowane elementy.

Żądanie ExportDocumentsRequest

Prośba dotycząca usługi FirestoreAdmin.ExportDocuments.

Pola
name

string

Baza danych do wyeksportowania. Powinien mieć format: projects/{project_id}/databases/{database_id}.
collection_ids[]

string

Identyfikatory kolekcji do wyeksportowania. „Nieokreślony” oznacza wszystkie kolekcje.
output_uri_prefix

string

Identyfikator URI wyjściowy. Obecnie obsługuje tylko identyfikatory URI Google Cloud Storage w formacie: gs://BUCKET_NAME[/NAMESPACE_PATH], gdzie BUCKET_NAME to nazwa zasobnika Google Cloud Storage, a NAMESPACE_PATH to opcjonalna ścieżka przestrzeni nazw Google Cloud Storage. Wybierając nazwę, pamiętaj o przestrzeganiu wytycznych dotyczących nazewnictwa w Google Cloud Storage: https://cloud.google.com/storage/docs/naming. Jeśli identyfikator URI jest zasobnikiem (bez ścieżki przestrzeni nazw), na podstawie czasu rozpoczęcia zostanie wygenerowany prefiks.

Odpowiedź na eksport Dokumentów

Zwrócony w polu odpowiedzi google.longrunning.Operation.

Pola
output_uri_prefix

string

Lokalizacja plików wyjściowych. W ten sposób możesz rozpocząć importowanie do Cloud Firestore (w tym lub innym projekcie) po pomyślnym zakończeniu operacji.

Żądanie GetIndexRequest

Prośba dotycząca usługi FirestoreAdmin.GetIndex.

Pola
name

string

Nazwa indeksu. Na przykład: projects/{project_id}/databases/{database_id}/indexes/{index_id}

Metadane importu dokumentów

Metadane operacji ImportDocuments.

Pola
start_time

Timestamp

Godzina rozpoczęcia pracy nad operację.
end_time

Timestamp

Czas zakończenia operacji (pomyślnie lub inaczej). Nie ustawiaj tego ustawienia, jeśli operacja jest nadal aktywna.
operation_state

OperationState

Stan operacji importu.
progress_documents

Progress

Szacunkowa liczba przetworzonych dokumentów.
progress_bytes

Progress

Szacowana liczba przetworzonych bajtów.
collection_ids[]

string

Które identyfikatory kolekcji mają być importowane.
input_uri_prefix

string

Lokalizacja importowanych dokumentów.

Żądanie ImportDocumentsRequest

Prośba dotycząca usługi FirestoreAdmin.ImportDocuments.

Pola
name

string

Baza danych, do której ma zostać zaimportowany. Powinien mieć format: projects/{project_id}/databases/{database_id}.
collection_ids[]

string

Identyfikatory kolekcji do zaimportowania. „Nie określono” oznacza, że wszystkie zbiory uwzględnione do importu.
input_uri_prefix

string

Lokalizacja wyeksportowanych plików. Ten atrybut musi być zgodny z wartością event_uri_prefix odpowiedzi ExportDocumentsResponse z zakończonego powodzeniem. Zobacz: google.firestore.admin.v1beta1.ExportDocumentsResponse.output_uri_prefix.

Indeks

Definicja indeksu.

Pola
name

string

Nazwa zasobu indeksu. Tylko dane wyjściowe.
collection_id

string

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

IndexField

Pola do indeksowania.
state

State

Stan indeksu. Tylko dane wyjściowe.

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ć.

Pole indeksu

Pole indeksu.

Pola
field_path

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

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.

Metadane operacji indeksowania

Metadane operacji indeksowania. Te metadane wypełniają pole metadanych google.longrunning.Operation.

Pola
start_time

Timestamp

Godzina rozpoczęcia pracy nad operację.
end_time

Timestamp

Czas zakończenia operacji (pomyślnie lub inaczej). Nie ustawiaj tego ustawienia, jeśli operacja jest nadal aktywna.
index

string

Zasób indeksu, na którym działa ta operacja. Na przykład: projects/{project_id}/databases/{database_id}/indexes/{index_id}
operation_type

OperationType

Typ operacji indeksowania.
cancelled

bool

Prawda, jeśli zamówienie google.longrunning.Operation zostało anulowane. Jeśli trwa anulowanie, ustawienie ma wartość true (prawda), ale google.longrunning.Operation.done ma wartość false (fałsz).
document_progress

Progress

Postęp istniejącej operacji mierzony w liczbie dokumentów.

Typ operacji

Typ operacji indeksowania.

Wartości w polu enum
OPERATION_TYPE_UNSPECIFIED Nie określono. Nigdy nie ustawiane przez serwer.
CREATING_INDEX Operacja tworzy indeks. Zainicjowane przez wywołanie CreateIndex.

Żądanie ListyIndeksów

Prośba dotycząca usługi FirestoreAdmin.ListIndexes.

Pola
parent

string

Nazwa bazy danych. Na przykład: projects/{project_id}/databases/{database_id}
filter

string
page_size

int32

Standardowy rozmiar strony listy.
page_token

string

Standardowy token strony z listą.

Odpowiedź Wyświetlanie indeksów

Odpowiedź dla: FirestoreAdmin.ListIndexes.

Pola
indexes[]

Index

Indeksy.
next_page_token

string

Standardowy token listy następnej strony.

Metadane lokalizacji

Ten typ nie zawiera pól.

Wiadomość metadanych dla: google.cloud.location.Location.metadata.

Stan operacji

Różne możliwe stany trwającej operacji.

Wartości w polu enum
STATE_UNSPECIFIED Nie określono.
INITIALIZING Prośba jest przygotowywana do przetworzenia.
PROCESSING Żądanie jest obecnie przetwarzane.
CANCELLING Żądanie jest w trakcie anulowania po tym, jak użytkownik wywołał w tej operacji funkcję google.longrunning.Operations.CancelOperation.
FINALIZING Prośba została przetworzona i jest w fazie finalizacji.
SUCCESSFUL Żądanie zostało zrealizowane.
FAILED Żądanie zostało przetworzone, ale wystąpił błąd.
CANCELLED Żądanie zostało anulowane, gdy użytkownik wywołał funkcję google.longrunning.Operations.CancelOperation.

Postęp

Mierzy postęp określonych danych.

Pola
work_completed

int64

Szacowana ilość ukończonego zadania. Pamiętaj, że może ona być większa niż work_estimated.
work_estimated

int64

Ile wysiłku trzeba wykonać. Jeśli oszacowanie pracy jest niedostępne, wartość wynosi zero. Może ulec zmianie w miarę postępów prac.