Package google.firestore.admin.v1beta2

Indeks

FirestoreAdmin

Operacje są tworzone przez usługę FirestoreAdmin, ale są dostępne przez usługę google.longrunning.Operations.

CreateIndex

rpc CreateIndex(CreateIndexRequest) returns (Operation)

Tworzy indeks złożony. Zwraca wartość google.longrunning.Operation, której można użyć do śledzenia stanu kompozycji. Metadane operacji będą typu IndexOperationMetadata.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie uwierzytelniania.
DeleteIndex

rpc DeleteIndex(DeleteIndexRequest) returns (Empty)

Usuwa indeks złożony.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie uwierzytelniania.
ExportDocuments

rpc ExportDocuments(ExportDocumentsRequest) returns (Operation)

Eksportuje kopię wszystkich dokumentów lub ich podzbioru z Google Cloud Firestore do innego systemu pamięci masowej, na przykład Google Cloud Storage. Ostatnie aktualizacje dokumentów 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 eksportowania zostanie anulowana przed zakończeniem, może ona pozostawić w Google Cloud Storage częściowe dane.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie uwierzytelniania.
GetField

rpc GetField(GetFieldRequest) returns (Field)

Pobiera metadane i konfigurację pola.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie uwierzytelniania.
GetIndex

rpc GetIndex(GetIndexRequest) returns (Index)

Pobiera indeks złożony.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie uwierzytelniania.
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żna monitorować i zarządzać nim za pomocą tworzonego zasobu operacji. Jeśli operacja importowania dokumentów zostanie anulowana, możliwe, że podzbiór danych został już zaimportowany do Cloud Firestore.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie uwierzytelniania.
ListFields

rpc ListFields(ListFieldsRequest) returns (ListFieldsResponse)

Wyświetla konfigurację pola i metadane tej bazy danych.

Obecnie FirestoreAdmin.ListFields obsługuje tylko pola listy, które zostały jawnie zastąpione. Aby wysłać to zapytanie, wywołaj to zdarzenie FirestoreAdmin.ListFields z filtrem ustawionym na wartość indexConfig.usesAncestorConfig:false.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie uwierzytelniania.
ListIndexes

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

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

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie uwierzytelniania.
UpdateField

rpc UpdateField(UpdateFieldRequest) returns (Operation)

Aktualizuje konfigurację pola. Obecnie aktualizacje pól dotyczą tylko konfiguracji indeksu pojedynczego pola. Wywołania FirestoreAdmin.UpdateField powinny jednak dostarczać maskę pola, aby uniknąć zmiany konfiguracji, o której element wywołujący nie wie. Maską pola należy określić jako: { paths: "index_config" }.

To wywołanie zwraca wartość google.longrunning.Operation, która może służyć do śledzenia stanu aktualizacji pola. Metadane operacji będą typu FieldOperationMetadata.

Aby skonfigurować domyślne ustawienia pola bazy danych, użyj specjalnego pola Field o nazwie zasobu: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie uwierzytelniania.

CreateIndexRequest

Prośba dotycząca: FirestoreAdmin.CreateIndex.

Pola
parent

string

Nazwa elementu nadrzędnego formularza projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
index

Index

Indeks złożony do utworzenia.

DeleteIndexRequest

Prośba dotycząca: FirestoreAdmin.DeleteIndex.

Pola
name

string

Nazwa formularza projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

ExportDocumentsMetadata

Metadane wyników dla zapytania google.longrunning.Operation z FirestoreAdmin.ExportDocuments.

Pola
start_time

Timestamp

Godzina rozpoczęcia tej operacji.
end_time

Timestamp

Czas zakończenia tej operacji. Wartość ta zostanie nieskonfigurowana, jeśli operacja jest w toku.
operation_state

OperationState

Stan operacji eksportowania.
progress_documents

Progress

Postęp tej operacji w dokumentach.
progress_bytes

Progress

Postęp tej operacji (w bajtach).
collection_ids[]

string

Identyfikatory kolekcji, które są eksportowane.
output_uri_prefix

string

Miejsce, do którego są eksportowane elementy.

ExportDocumentsRequest

Prośba dotycząca: FirestoreAdmin.ExportDocuments.

Pola
name

string

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

string

Identyfikatory kolekcji do wyeksportowania. Nieokreślone 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 wytycznych dotyczących nazw w Google Cloud Storage: https://cloud.google.com/storage/docs/naming. Jeśli identyfikator URI jest zasobnikiem (bez ścieżki przestrzeni nazw), prefiks zostanie wygenerowany na podstawie czasu rozpoczęcia.

ExportDocumentsResponse

Zwracana w polu odpowiedzi google.longrunning.Operation.

Pola
output_uri_prefix

string

Lokalizacja plików wyjściowych. Możesz użyć tych informacji, aby rozpocząć import do Cloud Firestore (tego lub innego projektu) po pomyślnym zakończeniu operacji.

Zaawansowana

Reprezentuje pojedyncze pole w bazie danych.

Pola są pogrupowane według „Grupy kolekcji”, która reprezentuje wszystkie zbiory w bazie danych o tym samym identyfikatorze.

Pola
name

string

Nazwa pola formularza projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

Ścieżka pola może być prostą nazwą pola, np. address, lub ścieżką do pól w obrębie wartości mapy, np. address.city, lub specjalną ścieżką pola. Jedynym prawidłowym polem specjalnym jest *, które reprezentuje dowolne pole.

Ścieżki pól można podawać w cudzysłowach za pomocą znaków (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include:*,., ``` (backtick),[,]” oraz dowolnych symboli ASCII.

Przykłady: (uwaga: komentarze w tym miejscu są zapisywane w składni Markdown, dlatego istnieje dodatkowa warstwa lewików reprezentujących blok kodu) \address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. `*`represents a field named*`, a nie żadne pole.

Specjalny Field zawiera domyślne ustawienia indeksowania dla wszystkich pól. Nazwa zasobu tego pola to: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/* Indeksy zdefiniowane w tym elemencie Field będą stosowane do wszystkich pól, które nie mają własnej konfiguracji indeksu Field.
index_config

IndexConfig

Konfiguracja indeksu dla tego pola. Jeśli zasada jest nieskonfigurowana, indeksowanie pól jest przywracane do konfiguracji określonej przez zasadę ancestor_field. Aby wyraźnie usunąć wszystkie indeksy dla tego pola, określ konfigurację indeksu z pustą listą indeksów.

IndexConfig

Konfiguracja indeksu dla tego pola.

Pola
indexes[]

Index

Indeksy obsługiwane w przypadku tego pola.
uses_ancestor_config

bool

Tylko dane wyjściowe. Jeśli ma wartość prawda, konfiguracja indeksu obiektu Field jest ustawiana na podstawie konfiguracji określonej przez ancestor_field. Jeśli zasada ma wartość Fałsz, konfiguracja indeksu obiektu Field jest wyraźnie zdefiniowana.
ancestor_field

string

Tylko dane wyjściowe. Określa nazwę zasobu Field, z którego skonfigurowano indeks tego pola (gdy uses_ancestor_config ma wartość prawda) lub z której wartość zostałaby ustawiona, jeśli to pole nie miało konfiguracji indeksu (gdy uses_ancestor_config ma wartość fałsz).
reverting

bool

Tylko dane wyjściowe Jeśli ma wartość prawda, konfiguracja indeksu obiektu Field jest w trakcie cofania. Po zakończeniu konfiguracja indeksu przejdzie do tego samego stanu co pole określone w polu ancestor_field. Gdy to nastąpi, uses_ancestor_config będzie mieć wartość true, a reverting zmieni wartość na false.

FieldOperationMetadata

Metadane wyników dla zapytania google.longrunning.Operation z FirestoreAdmin.UpdateField.

Pola
start_time

Timestamp

Godzina rozpoczęcia tej operacji.
end_time

Timestamp

Czas zakończenia tej operacji. Wartość ta zostanie nieskonfigurowana, jeśli operacja jest w toku.
field

string

Zasób pola, na którym działa ta operacja. Na przykład: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}
index_config_deltas[]

IndexConfigDelta

Lista elementów IndexConfigDelta, która opisuje cel tej operacji.
state

OperationState

Stan operacji.
document_progress

Progress

Postęp tej operacji w dokumentach.
bytes_progress

Progress

Postęp tej operacji (w bajtach).

IndexConfigDelta

Informacje o zmianie konfiguracji indeksu.

Pola
change_type

ChangeType

Określa, jak zmienia się indeks.
index

Index

Zmieniany indeks.

ChangeType

Określa, jak zmienia się indeks.

Wartości w polu enum
CHANGE_TYPE_UNSPECIFIED Nie określono lub nie wiadomo, jaki rodzaj zmiany
ADD Dodaję indeks pojedynczego pola.
REMOVE Usuwam indeks pojedynczego pola.

GetFieldRequest

Prośba dotycząca: FirestoreAdmin.GetField.

Pola
name

string

Nazwa formularza projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

GetIndexRequest

Prośba dotycząca: FirestoreAdmin.GetIndex.

Pola
name

string

Nazwa formularza projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

ImportDocumentsMetadata

Metadane wyników dla zapytania google.longrunning.Operation z FirestoreAdmin.ImportDocuments.

Pola
start_time

Timestamp

Godzina rozpoczęcia tej operacji.
end_time

Timestamp

Czas zakończenia tej operacji. Wartość ta zostanie nieskonfigurowana, jeśli operacja jest w toku.
operation_state

OperationState

Stan operacji importu.
progress_documents

Progress

Postęp tej operacji w dokumentach.
progress_bytes

Progress

Postęp tej operacji (w bajtach).
collection_ids[]

string

Identyfikatory kolekcji, które są importowane.
input_uri_prefix

string

Lokalizacja importowanych dokumentów.

ImportDocumentsRequest

Prośba dotycząca: FirestoreAdmin.ImportDocuments.

Pola
name

string

Baza danych, do której ma nastąpić import. Powinien mieć taki format: projects/{project_id}/databases/{database_id}.
collection_ids[]

string

Identyfikatory kolekcji do zaimportowania. Nieokreślone oznacza, że import obejmuje wszystkie kolekcje.
input_uri_prefix

string

Lokalizacja wyeksportowanych plików. Musi on być zgodny z parametrem „output_uri_prefix” atrybutu ExportDocumentsResponse z eksportu, który został ukończony. Zobacz: google.firestore.admin.v1beta2.ExportDocumentsResponse.output_uri_prefix.

Indeks

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

Pola
name

string

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

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

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

State

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

IndexField

Pole w indeksie. Wartość pola_path określa, które pole jest indeksowane, a pole value_mode opisuje sposób indeksowania wartości pola.

Pola
field_path

string

Może to być nazwa. W przypadku indeksów pojedynczych pól wartość musi być zgodna z nazwą pola lub może zostać pominięte.
Pole sumy value_mode. Sposób indeksowania wartości pola. value_mode może być tylko jedną z tych wartości:
order

Order

Wskazuje, że to pole umożliwia porządkowanie według określonej kolejności lub porównywanie za pomocą znaków =, <, <=, >, >=.
array_config

ArrayConfig

Wskazuje, że to pole obsługuje operacje na array_value s.

ArrayConfig

Obsługiwane konfiguracje wartości tablicy.

Wartości w polu enum
ARRAY_CONFIG_UNSPECIFIED Indeks nie obsługuje dodatkowych zapytań dotyczących tablicy.
CONTAINS Indeks obsługuje zapytania do opanowania tablic.

Zamówienie

Obsługiwane kolejność.

Wartości w polu enum
ORDER_UNSPECIFIED Kolejność jest nieokreślona. Nieprawidłowa opcja.
ASCENDING Pole jest uporządkowane rosnąco według wartości.
DESCENDING Zawartość pola jest uporządkowana malejąco według wartości pola.

QueryScope

Zakres zapytania określa zakres, w którym jest wykonywane zapytanie. Tę wartość określa się w polu from elementu StructuredQuery.

Wartości w polu enum
QUERY_SCOPE_UNSPECIFIED Zakres zapytania jest nieokreślony. Nieprawidłowa opcja.
COLLECTION Indeksy z określonym zakresem zapytań dotyczących kolekcji umożliwiają wysyłanie zapytań do zbioru podrzędnego określonego w danym dokumencie, określonego w czasie wykonywania zapytania i o identyfikatorze kolekcji określonym przez indeks.
COLLECTION_GROUP Indeksy z określonym zakresem zapytań dla grupy kolekcji zezwalają na wysyłanie zapytań do wszystkich kolekcji z identyfikatorem kolekcji określonym przez indeks.

Stan

Stan indeksu. Podczas tworzenia indeksu będzie on miał stan CREATING. Jeśli indeks zostanie utworzony, przejdzie do stanu READY. Jeśli podczas tworzenia indeksu wystąpi problem, indeks zostanie przeniesiony do stanu NEEDS_REPAIR.

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.
NEEDS_REPAIR 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. Użyj interfejsu google.longrunning.Operations API, aby ustalić, dlaczego ostatnia próba utworzenia tego indeksu nie powiodła się, a następnie ponownie utwórz indeks.

IndexOperationMetadata

Metadane wyników dla zapytania google.longrunning.Operation z FirestoreAdmin.CreateIndex.

Pola
start_time

Timestamp

Godzina rozpoczęcia tej operacji.
end_time

Timestamp

Czas zakończenia tej operacji. Wartość ta zostanie nieskonfigurowana, jeśli operacja jest w toku.
index

string

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

OperationState

Stan operacji.
progress_documents

Progress

Postęp tej operacji w dokumentach.
progress_bytes

Progress

Postęp tej operacji (w bajtach).

ListFieldsRequest

Prośba dotycząca: FirestoreAdmin.ListFields.

Pola
parent

string

Nazwa elementu nadrzędnego formularza projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
filter

string

Filtr, który zostanie zastosowany do wyników z listy. Obecnie FirestoreAdmin.ListFields obsługuje tylko pola listy, które zostały jawnie zastąpione. Aby wysłać to zapytanie, wywołaj to zdarzenie FirestoreAdmin.ListFields z filtrem ustawionym na wartość indexConfig.usesAncestorConfig:false.
page_size

int32

Liczba wyników do zwrócenia.
page_token

string

Token strony zwrócony z poprzedniego wywołania funkcji FirestoreAdmin.ListFields, który może zostać użyty do wyświetlenia następnej strony wyników.

ListFieldsResponse

Odpowiedź dotycząca: FirestoreAdmin.ListFields.

Pola
fields[]

Field

Wymagane pola.
next_page_token

string

Token strony, który może służyć do żądania innej strony wyników. Jeśli to pole jest puste, jest to ostatnia strona.

ListIndexesRequest

Prośba dotycząca: FirestoreAdmin.ListIndexes.

Pola
parent

string

Nazwa elementu nadrzędnego formularza projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
filter

string

Filtr, który zostanie zastosowany do wyników z listy.
page_size

int32

Liczba wyników do zwrócenia.
page_token

string

Token strony zwrócony z poprzedniego wywołania funkcji FirestoreAdmin.ListIndexes, który może zostać użyty do wyświetlenia następnej strony wyników.

ListIndexesResponse

Odpowiedź dotycząca: FirestoreAdmin.ListIndexes.

Pola
indexes[]

Index

Żądane indeksy.
next_page_token

string

Token strony, który może służyć do żądania innej strony wyników. Jeśli to pole jest puste, jest to ostatnia strona.

OperationState

Opisuje stan operacji.

Wartości w polu enum
OPERATION_STATE_UNSPECIFIED Nie określono.
INITIALIZING Żądanie jest przygotowywane do przetworzenia.
PROCESSING Żądanie jest obecnie przetwarzane.
CANCELLING Żądanie jest w trakcie anulowania po tym, jak użytkownik wywołał tę operację google.longrunning.Operations.CancelOperation.
FINALIZING Prośba została przetworzona i jest w trakcie finalizacji.
SUCCESSFUL Żądanie zostało przetworzone pomyślnie.
FAILED Żądanie zostało zakończone, ale wystąpił błąd.
CANCELLED Żądanie zostało zakończone po tym, jak użytkownik wywołał google.longrunning.Operations.CancelOperation.

Postęp

Opisuje postęp operacji. Jednostka pracy jest ogólna i należy ją interpretować w zależności od tego, gdzie używany jest atrybut Progress.

Pola
estimated_work

int64

Szacunkowy nakład pracy.
completed_work

int64

Ilość wykonanych zadań.

UpdateFieldRequest

Prośba dotycząca: FirestoreAdmin.UpdateField.

Pola
field

Field

Pole do zaktualizowania.
update_mask

FieldMask

Maska powiązana z polem. Jeśli określisz konfigurację, w polu zostanie zaktualizowana tylko konfiguracja określona przez tę maskę pola.