Indeks
FirestoreAdmin
(interfejs)Backup
(komunikat)Backup.State
(wyliczenie)BackupSchedule
(komunikat)CreateBackupScheduleRequest
(komunikat)CreateDatabaseMetadata
(komunikat)CreateDatabaseRequest
(komunikat)CreateIndexRequest
(komunikat)DailyRecurrence
(komunikat)Database
(komunikat)Database.AppEngineIntegrationMode
(wyliczenie)Database.CmekConfig
(komunikat)Database.ConcurrencyMode
(wyliczenie)Database.DatabaseType
(wyliczenie)Database.DeleteProtectionState
(wyliczenie)Database.PointInTimeRecoveryEnablement
(wyliczenie)DeleteBackupRequest
(komunikat)DeleteBackupScheduleRequest
(komunikat)DeleteDatabaseMetadata
(komunikat)DeleteDatabaseRequest
(komunikat)DeleteIndexRequest
(komunikat)ExportDocumentsMetadata
(komunikat)ExportDocumentsRequest
(komunikat)ExportDocumentsResponse
(komunikat)Field
(komunikat)Field.IndexConfig
(komunikat)Field.TtlConfig
(komunikat)Field.TtlConfig.State
(wyliczenie)FieldOperationMetadata
(komunikat)FieldOperationMetadata.IndexConfigDelta
(komunikat)FieldOperationMetadata.IndexConfigDelta.ChangeType
(wyliczenie)FieldOperationMetadata.TtlConfigDelta
(komunikat)FieldOperationMetadata.TtlConfigDelta.ChangeType
(wyliczenie)GetBackupRequest
(komunikat)GetBackupScheduleRequest
(komunikat)GetDatabaseRequest
(komunikat)GetFieldRequest
(komunikat)GetIndexRequest
(komunikat)ImportDocumentsMetadata
(komunikat)ImportDocumentsRequest
(komunikat)Index
(komunikat)Index.ApiScope
(wyliczenie)Index.IndexField
(komunikat)Index.IndexField.ArrayConfig
(wyliczenie)Index.IndexField.Order
(wyliczenie)Index.IndexField.VectorConfig
(komunikat)Index.IndexField.VectorConfig.FlatIndex
(komunikat)Index.QueryScope
(wyliczenie)Index.State
(wyliczenie)IndexOperationMetadata
(komunikat)ListBackupSchedulesRequest
(komunikat)ListBackupSchedulesResponse
(komunikat)ListBackupsRequest
(komunikat)ListBackupsResponse
(komunikat)ListDatabasesRequest
(komunikat)ListDatabasesResponse
(komunikat)ListFieldsRequest
(komunikat)ListFieldsResponse
(komunikat)ListIndexesRequest
(komunikat)ListIndexesResponse
(komunikat)LocationMetadata
(komunikat)OperationState
(wyliczenie)Progress
(komunikat)RestoreDatabaseMetadata
(komunikat)RestoreDatabaseRequest
(komunikat)UpdateBackupScheduleRequest
(komunikat)UpdateDatabaseMetadata
(komunikat)UpdateDatabaseRequest
(komunikat)UpdateFieldRequest
(komunikat)WeeklyRecurrence
(komunikat)
Administrator Firestore
Interfejs Cloud Firestore Admin API.
Ten interfejs API udostępnia kilka usług administracyjnych w Cloud Firestore.
Projekt, baza danych, przestrzeń nazw, kolekcja, grupa kolekcji i dokument są używane zgodnie z definicją interfejsu Google Cloud Firestore API.
Operacja: operacja oznacza pracę wykonywaną w tle.
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.
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.
Wykonana operacja może zostać usunięta, tak aby nie była już wymieniona w kolekcji operacji. Operacje to proces czyszczenia pamięci urządzenia po 30 dniach. Domyślnie ListOperations zwraca tylko w toku i nieudanych operacjach. Aby wyświetlić listę ukończonych operacji, wyślij żądanie ListOperations z użyciem filtra done: true
.
Operacje są tworzone przez usługę FirestoreAdmin
, ale dostęp do nich uzyskuje się przez usługę google.longrunning.Operations
.
Harmonogram tworzenia kopii zapasowych |
---|
Tworzy harmonogram tworzenia kopii zapasowych w bazie danych. W bazie danych można skonfigurować maksymalnie 2 harmonogramy tworzenia kopii zapasowych, 1 dzienny harmonogram tworzenia kopii zapasowych i 1 tygodniowy harmonogram tworzenia kopii zapasowych.
|
Tworzenie bazy danych |
---|
Utworzenie bazy danych.
|
Utwórz indeks |
---|
Tworzy indeks złożony. Spowoduje to zwrócenie kodu
|
Usuń kopię zapasową |
---|
Usuwa kopię zapasową.
|
Harmonogram usuwania kopii zapasowej |
---|
Usuwa harmonogram tworzenia kopii zapasowych.
|
Usuń bazę danych |
---|
Usuwa bazę danych.
|
Usuń indeks |
---|
Usuwa indeks złożony.
|
ExportDocuments |
---|
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. Więcej informacji o działaniu eksportu i formacie wyjściowym znajdziesz na stronie https://cloud.google.com/firestore/docs/manage-data/export-import.
|
Pobieranie kopii zapasowej |
---|
Pobiera informacje o kopii zapasowej.
|
Harmonogram pobierania kopii zapasowej |
---|
Pobiera informacje o harmonogramie tworzenia kopii zapasowych.
|
Pobieranie bazy danych |
---|
Pobiera informacje o bazie danych.
|
GetField |
---|
Pobiera metadane i konfigurację pola.
|
GetIndex |
---|
Pobiera indeks złożony.
|
ImportDocuments |
---|
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.
|
Wyświetlanie listy harmonogramów tworzenia kopii zapasowych |
---|
Wyświetl harmonogramy tworzenia kopii zapasowych.
|
Wyświetlanie listy kopii zapasowych |
---|
Zawiera listę wszystkich kopii zapasowych.
|
Wyświetlanie listy baz danych |
---|
Wyświetl wszystkie bazy danych w projekcie.
|
Wyświetlanie listy pól |
---|
Zawiera konfigurację pól i metadane tej bazy danych. Obecnie
|
Wyświetlanie listy indeksów |
---|
Wyświetla listę indeksów złożonych.
|
Przywracanie bazy danych |
---|
Tworzy nową bazę danych przez przywrócenie danych z istniejącej kopii zapasowej. Nowa baza danych musi znajdować się w tym samym regionie chmury lub w wielu regionach co istniejąca kopia zapasowa. Działa to podobnie jak [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.CreateDatabase], ale zamiast tworzyć nową pustą bazę danych, tworzona jest nowa baza danych o typie bazy danych, konfiguracji indeksu i dokumentach z istniejącej kopii zapasowej.
|
Harmonogram tworzenia kopii zapasowej |
---|
Aktualizuje harmonogram tworzenia kopii zapasowych.
|
AktualizujBazę danych |
---|
Aktualizuje bazę danych.
|
Pole aktualizacji |
---|
Aktualizuje konfigurację pola. Obecnie aktualizacje pól mają zastosowanie tylko do konfiguracji indeksu z jednym polem. Jednak wywołania funkcji To wywołanie zwraca wartość Aby skonfigurować domyślne ustawienia pola bazy danych, użyj specjalnego elementu
|
Kopia zapasowa
Kopia zapasowa bazy danych Cloud Firestore.
Kopia zapasowa zawiera wszystkie dokumenty i konfiguracje indeksów dla danej bazy danych z określonego momentu.
Pola | |
---|---|
name |
Tylko dane wyjściowe. Unikalna nazwa zasobu kopii zapasowej. Format to |
database |
Tylko dane wyjściowe. Nazwa bazy danych Firestore, z której pochodzi kopia zapasowa. Format to |
database_uid |
Tylko dane wyjściowe. Wygenerowany przez system identyfikator UUID4 bazy danych Firestore, z której pochodzi kopia zapasowa. |
snapshot_time |
Tylko dane wyjściowe. Obecnie kopia zapasowa zawiera spójną zewnętrznie kopię bazy danych. |
expire_time |
Tylko dane wyjściowe. Sygnatura czasowa, kiedy ta kopia zapasowa traci ważność. |
state |
Tylko dane wyjściowe. Bieżący stan kopii zapasowej. |
Stan
Wskaż bieżący stan kopii zapasowej.
Wartości w polu enum | |
---|---|
STATE_UNSPECIFIED |
Stan nie jest określony. |
CREATING |
Trwa tworzenie oczekującej kopii zapasowej. Operacje na kopii zapasowej będą w tym stanie odrzucane. |
READY |
Kopia zapasowa jest gotowa i gotowa do użycia. |
NOT_AVAILABLE |
Kopia zapasowa jest obecnie niedostępna. |
Harmonogram tworzenia kopii zapasowych
Harmonogram tworzenia kopii zapasowych bazy danych Cloud Firestore.
Ten zasób należy do bazy danych, której kopia zapasowa jest tworzona, i jest usuwany razem z bazą danych. Rzeczywiste kopie zapasowe to nie.
Pola | |
---|---|
name |
Tylko dane wyjściowe. Unikalny identyfikator harmonogramu tworzenia kopii zapasowych we wszystkich lokalizacjach i bazach danych w danym projekcie. Zostanie ono przypisane automatycznie. Format to |
create_time |
Tylko dane wyjściowe. Sygnatura czasowa określająca, kiedy ten harmonogram tworzenia kopii zapasowych został utworzony i obowiązuje od tego czasu. Do tego czasu nie będą tworzone żadne kopie zapasowe dla tego harmonogramu. |
update_time |
Tylko dane wyjściowe. Sygnatura czasowa określająca, kiedy ten harmonogram tworzenia kopii zapasowych został ostatnio zaktualizowany. Przy pierwszym tworzeniu harmonogramu tworzenia kopii zapasowych ma on wartość równą funkcji create_time. |
retention |
W jakim momencie w przyszłości (np.w porównaniu z czasem utworzenia kopii zapasowej) ma zostać usunięta, np. przechowywać kopie zapasowe przez 7 dni. Maksymalny obsługiwany okres przechowywania to 14 tygodni. |
Pole sumy recurrence . Jedno pole do reprezentowania czasu wykonywania kopii zapasowych. recurrence może mieć tylko jedną z tych wartości: |
|
daily_recurrence |
W przypadku harmonogramu uruchamianego codziennie. |
weekly_recurrence |
Do harmonogramu uruchamianego co tydzień w określony dzień. |
Utworzenie żądania planowania kopii zapasowej
Prośba dotycząca usługi FirestoreAdmin.CreateBackupSchedule
.
Pola | |
---|---|
parent |
Wymagane. Nadrzędna baza danych. Format: |
backup_schedule |
Wymagane. Harmonogram tworzenia kopii zapasowych. |
Tworzenie metadanych bazy danych
Ten typ nie zawiera pól.
Metadane związane z operacją tworzenia bazy danych.
CreateDatabaseRequest
Prośba dotycząca usługi FirestoreAdmin.CreateDatabase
.
Pola | |
---|---|
parent |
Wymagane. Nazwa elementu nadrzędnego formularza |
database |
Wymagane. Baza danych do utworzenia. |
database_id |
Wymagane. Identyfikator używany dla bazy danych, który stanie się ostatnim komponentem nazwy zasobu bazy danych. Ta wartość powinna mieć od 4 do 63 znaków. Prawidłowe znaki to /[a-z][0-9]-/, w tym pierwszy znak litera, a ostatnia litera lub cyfra. Nie może mieć postaci /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. „(domyślnie)” identyfikator bazy danych jest również prawidłowy. |
Tworzenie żądania indeksu
Prośba dotycząca usługi FirestoreAdmin.CreateIndex
.
Pola | |
---|---|
parent |
Wymagane. Nazwa elementu nadrzędnego formularza |
index |
Wymagane. Indeks złożony do utworzenia. |
Codzienne powtarzanie
Ten typ nie zawiera pól.
Reprezentuje cykliczny harmonogram uruchamiany codziennie.
Strefa czasowa jest ustawiona na UTC.
Baza danych
Baza danych Cloud Firestore.
Pola | |
---|---|
name |
Nazwa zasobu bazy danych. Format: |
uid |
Tylko dane wyjściowe. Wygenerowany przez system identyfikator UUID4 tej bazy danych. |
create_time |
Tylko dane wyjściowe. Sygnatura czasowa określająca, kiedy ta baza danych została utworzona. Bazy danych utworzone przed 2016 rokiem nie wypełniają wartości create_time. |
update_time |
Tylko dane wyjściowe. Sygnatura czasowa określająca, kiedy ta baza danych została ostatnio zaktualizowana. Pamiętaj, że obejmuje to tylko aktualizacje zasobu bazy danych, a nie danych w niej zawartych. |
delete_time |
Tylko dane wyjściowe. Sygnatura czasowa usunięcia tej bazy danych. Ustaw tylko wtedy, gdy baza danych została usunięta. |
location_id |
Lokalizacja bazy danych. Listę dostępnych lokalizacji znajdziesz na stronie https://cloud.google.com/firestore/docs/locations. |
type |
Typ bazy danych. Informacje o tym, jak go wybrać, znajdziesz na stronie https://cloud.google.com/datastore/docs/firestore-or-datastore. |
concurrency_mode |
Tryb kontroli równoczesności, który ma być używany w tej bazie danych. |
version_retention_period |
Tylko dane wyjściowe. Okres, w którym wcześniejsze wersje danych są przechowywane w bazie danych. Dowolny Jeśli funkcja odzyskiwania do określonego momentu jest włączona, okres przechowywania wynosi 7 dni. W przeciwnym razie okres przechowywania wynosi 1 godzinę. |
earliest_version_time |
Tylko dane wyjściowe. Najwcześniejsza sygnatura czasowa, w której można odczytać z bazy danych starsze wersje danych. Patrz [version_retention_period] powyżej; to pole zawiera wartość Ta wartość jest stale aktualizowana i w chwili wysyłania zapytania staje się nieaktualna. Jeśli używasz tej wartości do odzyskiwania danych, pamiętaj, aby uwzględnić czas od momentu wysłania zapytania o wartość do momentu rozpoczęcia przywracania. |
point_in_time_recovery_enablement |
Określa, czy włączyć funkcję odzyskiwania danych w tej bazie danych. |
app_engine_integration_mode |
Tryb integracji App Engine, który ma być używany w przypadku tej bazy danych. |
key_prefix |
Tylko dane wyjściowe. Prefiks klucza dla tej bazy danych. Ten prefiks key_prefix jest używany w połączeniu z identyfikatorem projektu („ Ta wartość może być pusta. W takim przypadku identyfikator aplikacji używany w przypadku kluczy zakodowanych w adresie URL to identyfikator projektu (np. foo zamiast v~foo). |
delete_protection_state |
Stan ochrony przed usunięciem w bazie danych. |
cmek_config |
Opcjonalnie. Obecność wskazuje, że dla tej bazy danych włączony jest klucz CMEK. |
previous_id |
Tylko dane wyjściowe. Poprzedni identyfikator bazy danych zasobu bazy danych. To pole jest wypełniane tylko w przypadku usuniętych baz danych. |
etag |
Ta suma kontrolna jest obliczana przez serwer na podstawie wartości innych pól i może być wysyłana w przypadku żądań aktualizacji lub usunięcia, aby zapewnić klientowi aktualną wartość, zanim przejdziesz dalej. |
Tryb integracji z mechanizmem App Engine
Typ trybu integracji App Engine.
Wartości w polu enum | |
---|---|
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED |
Nieużywane. |
ENABLED |
Jeśli aplikacja App Engine znajduje się w tym samym regionie co ta baza danych, konfiguracja App Engine będzie miała wpływ na tę bazę danych. Obejmuje to wyłączenie aplikacji oraz i wyłączeniu zapisywania w tej bazie danych. |
DISABLED |
App Engine nie ma wpływu na możliwość obsługi żądań przez tę bazę danych. Jest to domyślne ustawienie dla baz danych utworzonych przy użyciu interfejsu Firestore API. |
Konfiguracja GCP
Konfiguracja klucza szyfrowania zarządzanego przez klienta (CMEK) dla bazy danych Firestore. Jeśli jej nie ma, baza danych jest zabezpieczona domyślnym kluczem szyfrowania Google.
Pola | |
---|---|
kms_key_name |
Wymagane. Do szyfrowania można używać tylko kluczy znajdujących się w tej samej lokalizacji co ta baza danych. W przypadku „wielu regionów” nam5 Firestore odpowiada temu, że Cloud KMS ma wiele regionów. W przypadku wielu regionów eur3 Firestore odpowiada regionowi eur3 w Cloud KMS obejmujący wiele regionów. Więcej informacji znajdziesz na https://cloud.google.com/kms/docs/locations. Oczekiwany format to |
active_key_version[] |
Tylko dane wyjściowe. Obecnie używane wersje klucza KMS. Podczas rotacji kluczy może być wiele używanych wersji klucza. Oczekiwany format to |
Tryb równoczesności
Typ trybu kontroli równoczesności transakcji.
Wartości w polu enum | |
---|---|
CONCURRENCY_MODE_UNSPECIFIED |
Nieużywane. |
OPTIMISTIC |
Używaj domyślnie optymistycznej kontroli równoczesności. Ten tryb jest dostępny w bazach danych Cloud Firestore. |
PESSIMISTIC |
Domyślnie używaj pesymistycznej kontroli równoczesności. Ten tryb jest dostępny w bazach danych Cloud Firestore. Jest to domyślne ustawienie Cloud Firestore. |
OPTIMISTIC_WITH_ENTITY_GROUPS |
Domyślnie używaj optymistycznej kontroli równoczesności z grupami encji. To jedyny tryb dostępny w Cloud Datastore. Ten tryb jest też dostępny w Cloud Firestore w trybie Datastore, ale nie jest zalecany. |
Typ bazy danych
Typ bazy danych. Informacje o tym, jak go wybrać, znajdziesz na stronie https://cloud.google.com/datastore/docs/firestore-or-datastore.
Zmiany trybu są dozwolone tylko wtedy, gdy baza danych jest pusta.
Wartości w polu enum | |
---|---|
DATABASE_TYPE_UNSPECIFIED |
Wartość domyślna. Ta wartość jest używana, jeśli typ bazy danych zostanie pominięty. |
FIRESTORE_NATIVE |
Tryb natywny Firestore |
DATASTORE_MODE |
Firestore w trybie Datastore. |
Usuwanie stanu ochrony
Stan ochrony przed usunięciem bazy danych.
Wartości w polu enum | |
---|---|
DELETE_PROTECTION_STATE_UNSPECIFIED |
Wartość domyślna. Nie określono typu ochrony przed usunięciem |
DELETE_PROTECTION_DISABLED |
Ochrona przed usunięciem jest wyłączona |
DELETE_PROTECTION_ENABLED |
Ochrona przed usunięciem jest włączona |
aktywowanie odzyskiwania za pomocą PointInTimeRecovery
Włączenie funkcji odzyskiwania do określonego momentu.
Wartości w polu enum | |
---|---|
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED |
Nieużywane. |
POINT_IN_TIME_RECOVERY_ENABLED |
Odczyty są obsługiwane w przypadku wybranych wersji danych z ostatnich 7 dni:
Do określenia obsługiwanych wersji można użyć pakietów |
POINT_IN_TIME_RECOVERY_DISABLED |
Odczyty są obsługiwane w przypadku dowolnej wersji danych z ostatniej godziny. |
Usunięcie żądania kopii zapasowej
Prośba dotycząca usługi FirestoreAdmin.DeleteBackup
.
Pola | |
---|---|
name |
Wymagane. Nazwa kopii zapasowej do usunięcia. format to |
Usunięcie żądania planowania kopii zapasowej
żądanie [FirestoreAdmin.DeleteBackupSchedules][].
Pola | |
---|---|
name |
Wymagane. Nazwa harmonogramu tworzenia kopii zapasowych. Format: |
Usuwanie metadanych bazy danych
Ten typ nie zawiera pól.
Metadane związane z operacją usuwania bazy danych.
UsuńŻądanie bazy danych
Prośba dotycząca usługi FirestoreAdmin.DeleteDatabase
.
Pola | |
---|---|
name |
Wymagane. Nazwa formularza |
etag |
Bieżący tag bazy danych. Jeśli podany jest parametr eTag, który nie jest zgodny z bieżącym parametrem bazy danych, usunięcie zostanie zablokowane i zostanie zwrócony błąd FAILED_PREcondition. |
DeleteIndexRequest
Prośba dotycząca usługi FirestoreAdmin.DeleteIndex
.
Pola | |
---|---|
name |
Wymagane. Nazwa formularza |
ExportDocumentsMetadata
Metadane google.longrunning.Operation
wyniku z FirestoreAdmin.ExportDocuments
.
Pola | |
---|---|
start_time |
Czas rozpoczęcia tej operacji. |
end_time |
Czas zakończenia tej operacji. Ustawienie nie zostanie ustawione, jeśli operacja będzie nadal wykonywana. |
operation_state |
Stan operacji eksportu. |
progress_documents |
Postęp tej operacji w dokumentach. |
progress_bytes |
Postęp tej operacji w bajtach. |
collection_ids[] |
Które identyfikatory kolekcji są eksportowane. |
output_uri_prefix |
Miejsce, do którego są eksportowane dokumenty. |
namespace_ids[] |
Identyfikatory przestrzeni nazw, które są eksportowane. |
snapshot_time |
Sygnatura czasowa określająca wersję eksportowanej bazy danych. Jeśli nie określono inaczej, nie ma gwarancji spójności eksportowanych dokumentów. |
Żądanie ExportDocumentsRequest
Prośba dotycząca usługi FirestoreAdmin.ExportDocuments
.
Pola | |
---|---|
name |
Wymagane. Baza danych do wyeksportowania. Powinien mieć format: |
collection_ids[] |
Które identyfikatory kolekcji mają być eksportowane. „Nieokreślony” oznacza wszystkie kolekcje. Każdy identyfikator kolekcji na tej liście musi być unikalny. |
output_uri_prefix |
Identyfikator URI wyjściowy. Obecnie obsługuje tylko identyfikatory URI Google Cloud Storage w formacie: |
namespace_ids[] |
Pusta lista reprezentuje wszystkie przestrzenie nazw. Jest to preferowane rozwiązanie w przypadku baz danych, które nie korzystają z przestrzeni nazw. Pusty element ciągu reprezentuje domyślną przestrzeń nazw. Należy go używać, jeśli baza danych ma dane w innych przestrzeniach nazw, ale nie chcesz ich uwzględniać. Każda przestrzeń nazw na tej liście musi być unikalna. |
snapshot_time |
Sygnatura czasowa określająca wersję bazy danych do wyeksportowania. Sygnatura czasowa musi być w przeszłości, zaokrąglona do minuty i nie wcześniejsza niż |
Odpowiedź na eksport Dokumentów
Zwrócony w polu odpowiedzi google.longrunning.Operation
.
Pola | |
---|---|
output_uri_prefix |
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. |
Pole
Reprezentuje jedno pole w bazie danych.
Pola są grupowane według „grupy kolekcji”, która reprezentuje wszystkie kolekcje w bazie danych o tym samym identyfikatorze.
Pola | |
---|---|
name |
Wymagane. Nazwa pola w formacie Ścieżka pola może być prostą nazwą pola, np. Ścieżki pól można cytować za pomocą znaków Przykłady: (uwaga: komentarze w tym miejscu są napisane w składni języka markdown, dlatego pojawia się dodatkowa warstwa znaków grawisowych reprezentujących blok kodu) Specjalny identyfikator |
index_config |
Konfiguracja indeksu dla tego pola. Jeśli jej nie skonfigurujesz, indeksowanie pól zostanie przywrócone do konfiguracji zdefiniowanej przez zasadę |
ttl_config |
Konfiguracja TTL dla: |
Konfiguracja indeksu
Konfiguracja indeksu dla tego pola.
Pola | |
---|---|
indexes[] |
Indeksy obsługiwane przez to pole. |
uses_ancestor_config |
Tylko dane wyjściowe. Jeśli zasada ma wartość prawda, konfiguracja indeksu |
ancestor_field |
Tylko dane wyjściowe. Określa nazwę zasobu pola |
reverting |
Tylko dane wyjściowe, jeśli ma wartość prawda, konfiguracja indeksu |
Konfiguracja TTl
Konfiguracja TTL (czasu życia) dokumentów, dla których ustawiono ten Field
.
Przechowywanie wartości sygnatury czasowej w polu z włączoną funkcją TTL będzie traktowane jako bezwzględny czas wygaśnięcia dokumentu. Wartości sygnatury czasowej z przeszłości wskazują, że dokument kwalifikuje się do natychmiastowego wygaśnięcia. Użycie innych typów danych lub pozostawienie tego pola spowoduje wyłączenie okresu ważności poszczególnych dokumentów.
Pola | |
---|---|
state |
Tylko dane wyjściowe. Stan konfiguracji TTL. |
Stan
Stan zastosowania konfiguracji TTL do wszystkich dokumentów.
Wartości w polu enum | |
---|---|
STATE_UNSPECIFIED |
Stan jest nieokreślony lub nieznany. |
CREATING |
Trwa stosowanie wartości TTL. Istnieje aktywna długo trwająca operacja w celu śledzenia zmiany. Nowo utworzone dokumenty będą miały określone wartości TTL zgodnie z żądaniem. Żądane wartości TTL istniejących dokumentów są nadal przetwarzane. Po przetworzeniu wartości TTL wszystkich istniejących dokumentów stan zmieni się na „AKTYWNE”. |
ACTIVE |
Wartość TTL jest aktywna dla wszystkich dokumentów. |
NEEDS_REPAIR |
Nie udało się włączyć konfiguracji TTL dla wszystkich istniejących dokumentów. Wartość TTL nowo utworzonych dokumentów będzie nadal stosowana. LRO zwrócona podczas ostatniej próby włączenia wartości TTL dla tego urządzenia Field nie udało się i może zawierać więcej szczegółów. |
Metadane operacji
Metadane google.longrunning.Operation
wyniku z FirestoreAdmin.UpdateField
.
Pola | |
---|---|
start_time |
Czas rozpoczęcia tej operacji. |
end_time |
Czas zakończenia tej operacji. Ustawienie nie zostanie ustawione, jeśli operacja będzie nadal wykonywana. |
field |
Zasób pola, na który działa ta operacja. Na przykład: |
index_config_deltas[] |
Lista elementów |
state |
Stan operacji. |
progress_documents |
Postęp tej operacji w dokumentach. |
progress_bytes |
Postęp tej operacji w bajtach. |
ttl_config_delta |
Opisuje delta konfiguracji TTL. |
IndexConfigDelta
Informacje o zmianie konfiguracji indeksu.
Pola | |
---|---|
change_type |
Określa sposób zmiany indeksu. |
index |
Zmieniany indeks. |
Typ zmiany
Określa sposób zmiany indeksu.
Wartości w polu enum | |
---|---|
CHANGE_TYPE_UNSPECIFIED |
Typ zmiany nie został określony lub nie jest znany. |
ADD |
Dodaję indeks pojedynczego pola. |
REMOVE |
Usuwam indeks pojedynczego pola. |
TtlConfigDelta
Informacje o zmianie konfiguracji TTL.
Pola | |
---|---|
change_type |
Określa, jak zmienia się konfiguracja TTL. |
Typ zmiany
Określa, jak zmienia się konfiguracja TTL.
Wartości w polu enum | |
---|---|
CHANGE_TYPE_UNSPECIFIED |
Typ zmiany nie został określony lub nie jest znany. |
ADD |
Dodaję konfigurację TTL. |
REMOVE |
Usuwam konfigurację TTL. |
Pobieranie żądania kopii zapasowej
Prośba dotycząca usługi FirestoreAdmin.GetBackup
.
Pola | |
---|---|
name |
Wymagane. Nazwa kopii zapasowej do pobrania. Format to |
Żądanie zaplanowania kopii zapasowej
Prośba dotycząca usługi FirestoreAdmin.GetBackupSchedule
.
Pola | |
---|---|
name |
Wymagane. Nazwa harmonogramu tworzenia kopii zapasowych. Format: |
Żądanie GetDatabaseRequest
Prośba dotycząca usługi FirestoreAdmin.GetDatabase
.
Pola | |
---|---|
name |
Wymagane. Nazwa formularza |
GetFieldRequest
Prośba dotycząca usługi FirestoreAdmin.GetField
.
Pola | |
---|---|
name |
Wymagane. Nazwa formularza |
Żądanie GetIndexRequest
Prośba dotycząca usługi FirestoreAdmin.GetIndex
.
Pola | |
---|---|
name |
Wymagane. Nazwa formularza |
Metadane importu dokumentów
Metadane google.longrunning.Operation
wyniku z FirestoreAdmin.ImportDocuments
.
Pola | |
---|---|
start_time |
Czas rozpoczęcia tej operacji. |
end_time |
Czas zakończenia tej operacji. Ustawienie nie zostanie ustawione, jeśli operacja będzie nadal wykonywana. |
operation_state |
Stan operacji importu. |
progress_documents |
Postęp tej operacji w dokumentach. |
progress_bytes |
Postęp tej operacji w bajtach. |
collection_ids[] |
Które identyfikatory kolekcji mają być importowane. |
input_uri_prefix |
Lokalizacja importowanych dokumentów. |
namespace_ids[] |
Identyfikatory przestrzeni nazw, które są importowane. |
Żądanie ImportDocumentsRequest
Prośba dotycząca usługi FirestoreAdmin.ImportDocuments
.
Pola | |
---|---|
name |
Wymagane. Baza danych, do której ma zostać zaimportowany. Powinien mieć format: |
collection_ids[] |
Identyfikatory kolekcji do zaimportowania. „Nie określono” oznacza, że wszystkie zbiory uwzględnione do importu. |
input_uri_prefix |
Lokalizacja wyeksportowanych plików. Ten atrybut musi być zgodny z wartością event_uri_prefix odpowiedzi ExportDocumentsResponse z zakończonego powodzeniem. Zobacz: |
namespace_ids[] |
Pusta lista reprezentuje wszystkie przestrzenie nazw. Jest to preferowane rozwiązanie w przypadku baz danych, które nie korzystają z przestrzeni nazw. Pusty element ciągu reprezentuje domyślną przestrzeń nazw. Należy go używać, jeśli baza danych ma dane w innych przestrzeniach nazw, ale nie chcesz ich uwzględniać. Każda przestrzeń nazw na tej liście musi być unikalna. |
Indeks
Indeksy Cloud Firestore umożliwiają proste i złożone zapytania dotyczące dokumentów w bazie danych.
Pola | |
---|---|
name |
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ć: |
query_scope |
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 umożliwiają 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. |
api_scope |
Zakres interfejsu API obsługiwany przez ten indeks. |
fields[] |
Pola obsługiwane przez ten indeks. W przypadku indeksów złożonych wymagana jest od 2 do 100 pól. Ostatni wpis w polu dotyczy zawsze ścieżki pola 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 |
Tylko dane wyjściowe. Stan obsługi indeksu. |
Interfejs API
Zakres interfejsu API definiuje interfejsy API (natywne (Firestore Native lub Firestore w trybie Datastore), które są obsługiwane w przypadku zapytań.
Wartości w polu enum | |
---|---|
ANY_API |
Tego indeksu może używać tylko natywny interfejs API Firestore. Jest to ustawienie domyślne. |
DATASTORE_MODE_API |
Indeksu może używać tylko interfejs Firestore w trybie zapytań API. |
Pole indeksu
Pole w indeksie. Parametr pola_path określa, które pole jest indeksowane, a pole value_mode opisuje sposób indeksowania wartości pola.
Pola | |
---|---|
field_path |
Może być wartością name. W przypadku indeksów z pojedynczym polem wartość ta musi być zgodna z nazwą pola lub może zostać pominięty. |
Pole sumy value_mode . Sposób indeksowania wartości pola. value_mode może mieć tylko jedną z tych wartości: |
|
order |
Wskazuje, że to pole obsługuje porządkowanie według określonej kolejności lub porównywanie przy użyciu znaków =, !=, <, <=, >, >=. |
array_config |
Wskazuje, że to pole obsługuje operacje na |
vector_config |
Wskazuje, że to pole obsługuje operacje dotyczące najbliższych sąsiadów i odległości na wektorze. |
Konfiguracja tablicy
Obsługiwane konfiguracje wartości tablicy.
Wartości w polu enum | |
---|---|
ARRAY_CONFIG_UNSPECIFIED |
Indeks nie obsługuje dodatkowych zapytań dotyczących tablic. |
CONTAINS |
Indeks obsługuje zapytania obejmujące tablicę. |
Zamówienie
Obsługiwane kolejności.
Wartości w polu enum | |
---|---|
ORDER_UNSPECIFIED |
Kolejność nie jest określona. Nieprawidłowa opcja. |
ASCENDING |
Pole jest uporządkowane według wartości pola rosnącego. |
DESCENDING |
Pole jest uporządkowane według wartości pola malejącego. |
Konfiguracja wektora
Konfiguracja indeksu do obsługi operacji wyszukiwania wektorowego
Pola | |
---|---|
dimension |
Wymagane. Wymiar wektora, do którego ma zastosowanie ta konfiguracja. Powstały indeks będzie zawierać tylko wektory tego wymiaru i można go użyć do wyszukiwania wektorowego z tym samym wymiarem. |
Pole sumy type . Typ używanego indeksu. type może mieć tylko jedną z tych wartości: |
|
flat |
Wskazuje, że indeks wektorów jest płaski. |
Indeks płaski
Ten typ nie zawiera pól.
Indeks, który przechowuje wektory w płaskiej strukturze danych i obsługuje dokładne wyszukiwanie.
Zakres zapytania
Zakres zapytania definiuje zakres, w którym uruchamiane jest zapytanie. Określa się to w polu from
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ą wykonywanie zapytań na zbiorze podrzędnym określonego dokumentu, określonym w czasie wykonywania zapytania i o identyfikatorze kolekcji określonym przez indeks. |
COLLECTION_GROUP |
Indeksy z określonym zakresem zapytań dotyczącym grupy kolekcji umożliwiają wykonywanie zapytań dotyczących wszystkich kolekcji, które mają identyfikator kolekcji określony przez indeks. |
COLLECTION_RECURSIVE |
Uwzględnij w indeksie wszystkie elementy nadrzędne kolekcji. Dostępne tylko w przypadku baz danych w trybie Datastore. |
Stan
Stan indeksu. Podczas tworzenia indeksu indeks będzie miał stan CREATING
. Jeśli indeks zostanie utworzony, przejdzie do stanu READY
. Jeśli podczas tworzenia indeksu wystąpi problem, zostanie on 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 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. |
NEEDS_REPAIR |
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ć. Użyj interfejsu google.longrunning.Operations API, aby ustalić, dlaczego operacja, która ostatnio próbowała utworzyć ten indeks, nie powiodła się, a następnie ponownie utwórz indeks. |
Metadane operacji indeksowania
Metadane google.longrunning.Operation
wyniku z FirestoreAdmin.CreateIndex
.
Pola | |
---|---|
start_time |
Czas rozpoczęcia tej operacji. |
end_time |
Czas zakończenia tej operacji. Ustawienie nie zostanie ustawione, jeśli operacja będzie nadal wykonywana. |
index |
Zasób indeksu, na który działa ta operacja. Na przykład: |
state |
Stan operacji. |
progress_documents |
Postęp tej operacji w dokumentach. |
progress_bytes |
Postęp tej operacji w bajtach. |
Wyświetlenie harmonogramu tworzenia kopii zapasowych
Prośba dotycząca usługi FirestoreAdmin.ListBackupSchedules
.
Pola | |
---|---|
parent |
Wymagane. Nadrzędna baza danych. Format to |
Wyświetlenie listy harmonogramów kopii zapasowej
Odpowiedź dla: FirestoreAdmin.ListBackupSchedules
.
Pola | |
---|---|
backup_schedules[] |
Lista wszystkich harmonogramów tworzenia kopii zapasowych. |
Wyświetlanie listy kopii zapasowych
Prośba dotycząca usługi FirestoreAdmin.ListBackups
.
Pola | |
---|---|
parent |
Wymagane. Lokalizacja, z której mają zostać utworzone kopie zapasowe. Format to |
Wyświetlenie listy kopii zapasowych
Odpowiedź dla: FirestoreAdmin.ListBackups
.
Pola | |
---|---|
backups[] |
Lista wszystkich kopii zapasowych projektu. |
unreachable[] |
Lista lokalizacji, z których nie udało się pobrać istniejących kopii zapasowych. Zamiast odrzucania całych żądań, gdy dana lokalizacja jest nieosiągalna, ta odpowiedź zwraca częściowy zbiór wyników i listę lokalizacji, do których nie można uzyskać dostępu. Żądanie można ponowić w odniesieniu do pojedynczej lokalizacji, aby uzyskać konkretny błąd. |
Żądanie wyświetlania baz danych
Żądanie wyświetlenia baz danych Firestore we wszystkich lokalizacjach projektu.
Pola | |
---|---|
parent |
Wymagane. Nazwa elementu nadrzędnego formularza |
show_deleted |
Jeśli ma wartość prawda, zwraca też usunięte zasoby. |
Odpowiedź ListDatabases
Lista baz danych projektu.
Pola | |
---|---|
databases[] |
Bazy danych w projekcie. |
unreachable[] |
Jeśli nie będzie można wyświetlić danych dotyczących poszczególnych baz danych, zostaną one zarejestrowane tutaj. Przykładowy wpis może wyglądać tak: projects/jakiś_projekt/locations/jakaś_lokalizacja Może się tak zdarzyć, jeśli region Cloud, w którym znajduje się baza danych, jest obecnie niedostępny. W tym przypadku nie możemy pobrać wszystkich informacji o bazie danych. Bardziej szczegółowy komunikat o błędzie (albo pobrać zasób) może być bardziej szczegółowy, wysyłając polecenie „Get” żądanie zasobu lub listy dotyczące konkretnej lokalizacji. |
Żądanie listy pól
Prośba dotycząca usługi FirestoreAdmin.ListFields
.
Pola | |
---|---|
parent |
Wymagane. Nazwa elementu nadrzędnego formularza |
filter |
Filtr, który ma być stosowany do listy wyników. Obecnie |
page_size |
Liczba wyników do zwrócenia. |
page_token |
Token strony zwrócony z poprzedniego wywołania funkcji |
Odpowiedź z polami listy
Odpowiedź dla: FirestoreAdmin.ListFields
.
Pola | |
---|---|
fields[] |
Wymagane pola. |
next_page_token |
Token strony, który może być używany do żądania innej strony wyników. Jeśli pole jest puste, oznacza to, że jest to ostatnia strona. |
Żądanie ListyIndeksów
Prośba dotycząca usługi FirestoreAdmin.ListIndexes
.
Pola | |
---|---|
parent |
Wymagane. Nazwa elementu nadrzędnego formularza |
filter |
Filtr, który ma być stosowany do listy wyników. |
page_size |
Liczba wyników do zwrócenia. |
page_token |
Token strony zwrócony z poprzedniego wywołania funkcji |
Odpowiedź Wyświetlanie indeksów
Odpowiedź dla: FirestoreAdmin.ListIndexes
.
Pola | |
---|---|
indexes[] |
Żądane indeksy. |
next_page_token |
Token strony, który może być używany do żądania innej strony wyników. Jeśli pole jest puste, oznacza to, że jest to ostatnia strona. |
Metadane lokalizacji
Ten typ nie zawiera pól.
Wiadomość metadanych dla: google.cloud.location.Location.metadata
.
Stan operacji
Opisuje stan operacji.
Wartości w polu enum | |
---|---|
OPERATION_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
Opisuje postęp operacji. Jednostka pracy jest ogólna i należy ją interpretować w zależności od tego, gdzie jest używany element Progress
.
Pola | |
---|---|
estimated_work |
Szacowany czas pracy. |
completed_work |
Ilość wykonanych zadań. |
Przywracanie metadanych bazy danych
Metadane instancji long-running operation
z żądania [RestoreDatabase][google.firestore.admin.v1.RestoreDatabase].
Pola | |
---|---|
start_time |
Czas rozpoczęcia przywracania. |
end_time |
Czas zakończenia przywracania bez ustawienia w przypadku trwającego przywracania. |
operation_state |
Stan operacji przywracania. |
database |
Nazwa przywracanej bazy danych. |
backup |
Nazwa kopii zapasowej, z której przywracano dane. |
progress_percentage |
Odległość przywracania jest szacowana jako odsetek pozostałego czasu. |
Żądanie przywracania bazy danych
Komunikat z prośbą o [FirestoreAdmin.RestoreDatabase][google.firestore.admin.v1.RestoreDatabase].
Pola | |
---|---|
parent |
Wymagane. Projekt, w którym ma zostać przywrócona baza danych. Format to |
database_id |
Wymagane. Identyfikator używany dla bazy danych, który stanie się ostatnim komponentem nazwy zasobu bazy danych. Ten identyfikator bazy danych nie może być powiązany z istniejącą bazą danych. Ta wartość powinna mieć od 4 do 63 znaków. Prawidłowe znaki to /[a-z][0-9]-/, w tym pierwszy znak litera, a ostatnia litera lub cyfra. Nie może mieć postaci /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. „(domyślnie)” identyfikator bazy danych również jest prawidłowy. |
Pole sumy
|
|
backup |
Kopia zapasowa, z której chcesz przywrócić dane. Musi pochodzić z tego samego projektu co projekt nadrzędny. Format to: |
Żądanie aktualizacji harmonogramu kopii zapasowej
Prośba dotycząca usługi FirestoreAdmin.UpdateBackupSchedule
.
Pola | |
---|---|
backup_schedule |
Wymagane. Harmonogram tworzenia kopii zapasowych do zaktualizowania. |
update_mask |
Lista pól do zaktualizowania. |
Aktualizowanie metadanych bazy danych
Ten typ nie zawiera pól.
Metadane związane z operacjami aktualizacji bazy danych.
Żądanie aktualizacji bazy danych
Prośba dotycząca usługi FirestoreAdmin.UpdateDatabase
.
Pola | |
---|---|
database |
Wymagane. Baza danych do aktualizacji. |
update_mask |
Lista pól do zaktualizowania. |
UpdateFieldRequest
Prośba dotycząca usługi FirestoreAdmin.UpdateField
.
Pola | |
---|---|
field |
Wymagane. Pole do zaktualizowania. |
update_mask |
Maska względem pola. Jeśli określisz wartość, tylko konfiguracja określona przez tę maskę pola zostanie zaktualizowana w tym polu. |
Powtarzanie co tydzień
Reprezentuje harmonogram cykliczny uruchamiany w określonym dniu tygodnia.
Strefa czasowa jest ustawiona na UTC.
Pola | |
---|---|
day |
Dzień tygodnia do uruchomienia. DAY_OF_WEEK_UNSPECIFIED jest niedozwolony. |