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
Cloud Firestore Admin API.
Ten interfejs API zapewnia kilka usług administracyjnych dla Cloud Firestore.
Do korzystania z projektów, baz danych, przestrzeni nazw, kolekcji, grupy kolekcji i dokumentu są używane zgodnie z definicją w interfejsie Google Cloud Firestore API.
Operacja: operacja oznacza działanie wykonywane w tle.
Usługa indeksu zarządza indeksami Cloud Firestore.
Indeks jest tworzony asynchronicznie. Dla każdej takiej operacji asynchronicznej tworzony jest zasób operacji. Zapytanie o stan operacji (w tym wszelkie napotkane błędy) można przesłać za pomocą zasobu operacji.
Kolekcja Operacje zawiera rejestr działań wykonanych dla określonego projektu (w tym wszelkich operacji w toku). Operacje nie są tworzone bezpośrednio, ale przez wywołania innych zbiorów lub zasobów.
Wykonana operacja może zostać usunięta, aby nie pojawiała się już w kolekcji operacji. Operacje to niepotrzebne dane po 30 dniach. Domyślnie ListOperations zwraca tylko trwające i nieudane operacje. Aby wyświetlić listę ukończonych operacji, wyślij żądanie ListOperations z filtrem done: true
.
Operacje są tworzone przez usługę FirestoreAdmin
, ale są dostępne przez usługę google.longrunning.Operations
.
Utwórz harmonogram kopii zapasowej |
---|
Tworzy harmonogram tworzenia kopii zapasowych w bazie danych. W bazie danych można skonfigurować maksymalnie 2 harmonogramy tworzenia kopii zapasowych: 1 codzienny harmonogram tworzenia kopii zapasowych i 1 tygodniowy harmonogram tworzenia kopii zapasowych.
|
Utwórz bazę danych |
---|
Utwórz bazę danych.
|
Utwórz indeks |
---|
Tworzy indeks złożony. Zwraca wartość
|
Usuń kopię zapasową |
---|
Usuwa kopię zapasową.
|
Usuń harmonogram tworzenia kopii zapasowych |
---|
Usuwa harmonogram tworzenia kopii zapasowych.
|
Usuwanie bazy danych |
---|
Usuwa bazę danych.
|
Usuń indeks |
---|
Usuwa indeks złożony.
|
EksportujDokumenty |
---|
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. Więcej informacji o sposobie eksportowania i formacie danych wyjściowych znajdziesz na https://cloud.google.com/firestore/docs/manage-data/export-import
|
Pobierz kopię zapasową |
---|
Pobiera informacje o kopii zapasowej.
|
Pobierz harmonogram tworzenia kopii zapasowych |
---|
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.
|
Importuj dokumenty |
---|
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.
|
Wyświetlanie listy harmonogramów tworzenia kopii zapasowych |
---|
Wyświetlenie listy harmonogramów tworzenia kopii zapasowych.
|
Wyświetlanie listy kopii zapasowych |
---|
Wyświetla listę wszystkich kopii zapasowych.
|
Wyświetlanie listy baz danych |
---|
Wyświetl wszystkie bazy danych w projekcie.
|
Pola list |
---|
Wyświetla konfigurację pola i metadane tej bazy danych. Obecnie
|
Wyświetlanie listy indeksów |
---|
Wyświetla listę indeksów złożonych.
|
Przywróć bazę danych |
---|
Tworzy nową bazę danych przez przywrócenie istniejącej kopii zapasowej. Nowa baza danych musi być w tym samym regionie chmury lub w wielu regionach co bieżąca kopia zapasowa. Działa to podobnie do [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.CreateDatabase] z tym wyjątkiem, że zamiast tworzyć nową pustą bazę danych, tworzona jest nowa baza danych z typem bazy danych, konfiguracją indeksu i dokumentami z istniejącej kopii zapasowej.
|
Aktualizowanie harmonogramu tworzenia kopii zapasowych |
---|
Aktualizuje harmonogram tworzenia kopii zapasowych.
|
Aktualizuj bazę danych |
---|
Aktualizuje bazę danych.
|
Pole aktualizacji |
---|
Aktualizuje konfigurację pola. Obecnie aktualizacje pól dotyczą tylko konfiguracji indeksu pojedynczego pola. Wywołania To wywołanie zwraca wartość Aby skonfigurować domyślne ustawienia pola bazy danych, użyj specjalnego pola
|
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: |
database |
Tylko dane wyjściowe. Nazwa bazy danych Firestore, z której pochodzi kopia zapasowa. Format: |
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. Kopia zapasowa zawiera obecnie spójną zewnętrznie kopię bazy danych. |
expire_time |
Tylko dane wyjściowe. Sygnatura czasowa wygaśnięcia kopii zapasowej. |
state |
Tylko dane wyjściowe. Obecny stan kopii zapasowej. |
Stan
Wskaż bieżący stan kopii zapasowej.
Wartości w polu enum | |
---|---|
STATE_UNSPECIFIED |
Stan nie jest określony. |
CREATING |
Nadal trwa tworzenie oczekującej kopii zapasowej. W tym stanie operacje na kopii zapasowej będą odrzucane. |
READY |
Kopia zapasowa jest 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, dla której jest tworzona kopia zapasowa, i jest usuwany razem z bazą danych. Rzeczywiste kopie zapasowe jednak nie.
Pola | |
---|---|
name |
Tylko dane wyjściowe. Unikalny identyfikator harmonogramu tworzenia kopii zapasowych we wszystkich lokalizacjach i bazach danych danego projektu. Zostanie ono przypisane automatycznie. Format: |
create_time |
Tylko dane wyjściowe. Sygnatura czasowa utworzenia tego harmonogramu tworzenia kopii zapasowych i od tego momentu obowiązuje. Przed tą datą nie będą tworzone żadne kopie zapasowe dla tego harmonogramu. |
update_time |
Tylko dane wyjściowe. Sygnatura czasowa ostatniej aktualizacji tego harmonogramu tworzenia kopii zapasowych. Gdy harmonogram tworzenia kopii zapasowych zostanie utworzony po raz pierwszy, wartość ta jest taka sama jak wartość create_time. |
retention |
W porównaniu do czasu utworzenia kopii zapasowej należy usunąć ją (np. zachować kopie zapasowe przez 7 dni). |
Pole sumy recurrence . Jedno z pól, które określa, kiedy tworzone będą kopie zapasowe. recurrence może być tylko jedną z tych wartości: |
|
daily_recurrence |
W przypadku harmonogramu uruchamianego codziennie. |
weekly_recurrence |
Dla harmonogramu uruchamianego co tydzień w określonym dniu. |
Żądanie tworzenia kopii zapasowej
Prośba dotycząca: FirestoreAdmin.CreateBackupSchedule
.
Pola | |
---|---|
parent |
To pole jest wymagane. Nadrzędna baza danych. Formatuj: |
backup_schedule |
To pole jest wymagane. Harmonogram tworzenia kopii zapasowych. |
Tworzenie metadanych bazy danych
Ten typ nie ma żadnych pól.
Metadane związane z operacją tworzenia bazy danych.
Utworzenie żądania bazy danych
Prośba dotycząca: FirestoreAdmin.CreateDatabase
.
Pola | |
---|---|
parent |
To pole jest wymagane. Nazwa elementu nadrzędnego formularza |
database |
To pole jest wymagane. Baza danych do utworzenia. |
database_id |
To pole jest wymagane. Identyfikator używany przez bazę danych, który stanie się ostatnim komponentem nazwy zasobu bazy danych. Powinna ona mieć od 4 do 63 znaków. Prawidłowe znaki to /[a-z][0-9]-/ , gdzie pierwszy znak to litera, a ostatnia litera lub cyfra. Nie może być jak identyfikator UUID /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. Identyfikator bazy danych „(domyślnie)” jest również prawidłowy. |
Żądanie CreateIndexRequest
Prośba dotycząca: FirestoreAdmin.CreateIndex
.
Pola | |
---|---|
parent |
To pole jest wymagane. Nazwa elementu nadrzędnego formularza |
index |
To pole jest wymagane. Indeks złożony do utworzenia. |
Powtarzanie dzienne
Ten typ nie ma żadnych pól.
Reprezentuje cykliczny harmonogram uruchamiany codziennie.
Strefa czasowa to UTC.
Baza danych
Baza danych Cloud Firestore.
Pola | |
---|---|
name |
Nazwa zasobu bazy danych. Format: |
uid |
Tylko dane wyjściowe. Wygenerowany przez system identyfikator UUID4 dla tej bazy danych. |
create_time |
Tylko dane wyjściowe. Sygnatura czasowa utworzenia tej bazy danych. Bazy danych utworzone przed 2016 r. nie są wypełniane pola create_time. |
update_time |
Tylko dane wyjściowe. Sygnatura czasowa ostatniej aktualizacji tej bazy danych. Pamiętaj, że obejmuje to tylko aktualizacje zasobu bazy danych, a nie zawarte w niej dane. |
delete_time |
Tylko dane wyjściowe. Sygnatura czasowa usunięcia tej bazy danych. Ustawiaj tylko wtedy, gdy baza danych została usunięta. |
location_id |
Lokalizacja bazy danych. Listę dostępnych lokalizacji znajdziesz na https://cloud.google.com/firestore/docs/locations. |
type |
Typ bazy danych. Informacje o wyborze znajdziesz na stronie https://cloud.google.com/datastore/docs/firestore-or-datastore. |
concurrency_mode |
Tryb kontroli równoczesności 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. Każdy element 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, po której można odczytać starsze wersje danych z bazy danych. Patrz [version_retention_period] powyżej; to pole jest wypełnione wartością Ta wartość jest stale aktualizowana i w momencie wysłania zapytania staje się nieaktualna. Jeśli używasz tej wartości do odzyskiwania danych, pamiętaj, by uwzględnić czas od zapytania o wartość do momentu rozpoczęcia przywracania. |
point_in_time_recovery_enablement |
Określa, czy włączyć funkcję odzyskiwania do określonego momentu w tej bazie danych. |
app_engine_integration_mode |
Tryb integracji App Engine używany na potrzeby tej bazy danych. |
key_prefix |
Tylko dane wyjściowe. Prefiks klucza dla tej bazy danych. Ten klucz_prefiks jest używany w połączeniu z identyfikatorem projektu („ Ta wartość może być pusta. W takim przypadku identyfikator appid, którego chcesz użyć w przypadku kluczy zakodowanych na potrzeby adresu URL, to project_id (np. foo zamiast v~foo). |
delete_protection_state |
Stan ochrony przed usunięciem bazy danych. |
cmek_config |
Opcjonalnie. Obecność oznacza, że klucz CMEK jest włączony w tej bazie danych. |
previous_id |
Tylko dane wyjściowe. Poprzedni identyfikator bazy danych zasobu bazy danych. 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 i usunięcia w celu sprawdzenia, czy klient ma aktualną wartość, zanim przejdziesz dalej. |
Tryb integracji AppEngine
Typ trybu integracji z App Engine.
Wartości w polu enum | |
---|---|
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED |
Nieużywany. |
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 i bazy danych oraz zapisów w tej bazie. |
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 tworzonych przy użyciu interfejsu Firestore API. |
Konfiguracja Cmek
Konfiguracja CMEK (klucza szyfrowania zarządzanego przez klienta) dla bazy danych Firestore. Jeśli go nie ma, baza danych jest zabezpieczona domyślnym kluczem szyfrowania Google.
Pola | |
---|---|
kms_key_name |
To pole jest wymagane. Do szyfrowania można używać tylko kluczy znajdujących się w tej samej lokalizacji co ta baza danych. W przypadku bazy danych nam5 w Firestore odpowiada to działaniu Cloud KMS w wielu regionach. W przypadku wielu regionów eur3 w Firestore odpowiada to Europie z wieloma regionami Cloud KMS. 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 klucza może występować 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żywany. |
OPTIMISTIC |
Domyślnie używaj 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 ustawienie domyślne Cloud Firestore. |
OPTIMISTIC_WITH_ENTITY_GROUPS |
Domyślnie używaj optymistycznej kontroli równoczesności w przypadku grup encji. To jedyny tryb dostępny w Cloud Datastore. Ten tryb jest też dostępny w Cloud Firestore z trybem Datastore, ale nie jest zalecany. |
Typ bazy danych
Typ bazy danych. Informacje o wyborze 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 |
Włączenie usługi PointInTimeRecovery
Włączenie funkcji odzyskiwania do określonego momentu.
Wartości w polu enum | |
---|---|
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED |
Nieużywany. |
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ć parametrów |
POINT_IN_TIME_RECOVERY_DISABLED |
Odczyty są obsługiwane dla każdej wersji danych z ostatniej godziny. |
Usuń żądanie kopii zapasowej
Prośba dotycząca: FirestoreAdmin.DeleteBackup
.
Pola | |
---|---|
name |
To pole jest wymagane. Nazwa kopii zapasowej do usunięcia. format to |
Żądanie usunięcia kopii zapasowej
Żądanie [FirestoreAdmin.Delete BackupSchedules][].
Pola | |
---|---|
name |
To pole jest wymagane. Nazwa harmonogramu tworzenia kopii zapasowych. Formatuj: |
Usuwanie metadanych bazy danych
Ten typ nie ma żadnych pól.
Metadane związane z operacją usuwania bazy danych.
Żądanie usunięcia bazy danych
Prośba dotycząca: FirestoreAdmin.DeleteDatabase
.
Pola | |
---|---|
name |
To pole jest wymagane. Nazwa formularza |
etag |
Bieżący tag bazy danych. Jeśli zostanie podany tag etag, który nie jest zgodny z bieżącym tagiem bazy danych, usunięcie zostanie zablokowane i wyświetli się błąd FAILED_PRECondition. |
Żądanie DeleteIndexRequest
Prośba dotycząca: FirestoreAdmin.DeleteIndex
.
Pola | |
---|---|
name |
To pole jest wymagane. Nazwa formularza |
ExportDocumentsMetadata
Metadane wyników dla zapytania google.longrunning.Operation
z FirestoreAdmin.ExportDocuments
.
Pola | |
---|---|
start_time |
Godzina rozpoczęcia tej operacji. |
end_time |
Czas zakończenia tej operacji. Wartość ta zostanie nieskonfigurowana, jeśli operacja jest w toku. |
operation_state |
Stan operacji eksportowania. |
progress_documents |
Postęp tej operacji w dokumentach. |
progress_bytes |
Postęp tej operacji (w bajtach). |
collection_ids[] |
Identyfikatory kolekcji, które są eksportowane. |
output_uri_prefix |
miejsce eksportowania dokumentów; |
namespace_ids[] |
Które identyfikatory przestrzeni nazw są eksportowane. |
snapshot_time |
Sygnatura czasowa odpowiadająca wersji eksportowanej bazy danych. Jeśli nie określono inaczej, nie ma gwarancji spójności eksportowanych dokumentów. |
Żądanie ExportDocumentsRequest
Prośba dotycząca: FirestoreAdmin.ExportDocuments
.
Pola | |
---|---|
name |
To pole jest wymagane. Baza danych do wyeksportowania. Powinien mieć taki format: |
collection_ids[] |
Identyfikatory kolekcji do wyeksportowania. Nieokreślone oznacza wszystkie kolekcje. |
output_uri_prefix |
Identyfikator URI wyjściowy. Obecnie obsługuje tylko identyfikatory URI Google Cloud Storage w formacie |
namespace_ids[] |
Pusta lista zawiera wszystkie przestrzenie nazw. Jest to preferowane użycie w przypadku baz danych, które nie korzystają z przestrzeni nazw. Pusty element ciągu to domyślna przestrzeń nazw. Należy go używać, jeśli baza danych zawiera dane w innych przestrzeniach nazw, ale nie chce ich uwzględniać. Każda przestrzeń nazw na tej liście musi być unikalna. |
snapshot_time |
Sygnatura czasowa odpowiadająca wersji bazy danych do wyeksportowania. Sygnatura czasowa musi być datą przeszłą i zaokrąglona do minuty. Nie może być starsza niż |
ExportDocumentsResponse
Zwracana w polu odpowiedzi google.longrunning.Operation
.
Pola | |
---|---|
output_uri_prefix |
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. |
Pole
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 |
To pole jest wymagane. Nazwa pola formularza Ścieżka pola może być prostą nazwą pola, np. Ścieżki pól można podawać w cudzysłowach za pomocą znaków Przykłady: (uwaga: komentarze w tym miejscu są zapisywane w składni Markdown, dlatego istnieje dodatkowa warstwa lewików reprezentujących blok kodu) Specjalny |
index_config |
Konfiguracja indeksu dla tego pola. Jeśli zasada jest nieskonfigurowana, indeksowanie pól jest przywracane do konfiguracji określonej przez zasadę |
ttl_config |
Konfiguracja TTL dla zasobnika |
Konfiguracja indeksu
Konfiguracja indeksu dla tego pola.
Pola | |
---|---|
indexes[] |
Indeksy obsługiwane w przypadku tego pola. |
uses_ancestor_config |
Tylko dane wyjściowe. Jeśli ma wartość prawda, konfiguracja indeksu obiektu |
ancestor_field |
Tylko dane wyjściowe. Określa nazwę zasobu |
reverting |
Tylko dane wyjściowe Jeśli ma wartość prawda, konfiguracja indeksu obiektu |
Konfiguracja ttl
Konfiguracja czasu życia danych (TTL) dla dokumentów, które mają ustawiony ten parametr Field
.
Zapisywanie wartości sygnatury czasowej w polu z włączoną wartością TTL będzie traktowane jako bezwzględny czas wygaśnięcia dokumentu. Wartości sygnatur czasowych z przeszłości wskazują, że dokument kwalifikuje się do natychmiastowego wygaśnięcia. Użycie innego typu danych lub pozostawienie tego pola spowoduje wyłączenie wygaśnięcia ważności pojedynczego dokumentu.
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 |
Stosuję wartość TTL. Istnieje aktywna długo trwająca operacja, aby śledzić zmianę. Do nowo zapisanych dokumentów zostaną zastosowane wartości TTL. Żą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 „AKTYWNY”. |
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. Do nowo zapisanych dokumentów nadal będą stosowane wartości TTL. Wartość LRO zwrócona podczas ostatniej próby włączenia wartości TTL dla tego urządzenia Field nie powiodła się. Możesz mieć więcej szczegółów. |
Metadane operacji w polu
Metadane wyników dla zapytania google.longrunning.Operation
z FirestoreAdmin.UpdateField
.
Pola | |
---|---|
start_time |
Godzina rozpoczęcia tej operacji. |
end_time |
Czas zakończenia tej operacji. Wartość ta zostanie nieskonfigurowana, jeśli operacja jest w toku. |
field |
Zasób pola, na którym 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. |
Deltakonfiguracja indeksu
Informacje o zmianie konfiguracji indeksu.
Pola | |
---|---|
change_type |
Określa, jak zmienia się indeks. |
index |
Zmieniany indeks. |
Typ zmiany
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. |
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 |
Nie określono lub nie wiadomo, jaki rodzaj zmiany |
ADD |
Dodaję konfigurację TTL. |
REMOVE |
Usuwam konfigurację TTL. |
Pobierz żądanie kopii zapasowej
Prośba dotycząca: FirestoreAdmin.GetBackup
.
Pola | |
---|---|
name |
To pole jest wymagane. Nazwa kopii zapasowej do pobrania. Format: |
Żądanie harmonogramu tworzenia kopii zapasowych
Prośba dotycząca: FirestoreAdmin.GetBackupSchedule
.
Pola | |
---|---|
name |
To pole jest wymagane. Nazwa harmonogramu tworzenia kopii zapasowych. Formatuj: |
Pobieranie żądania bazy danych
Prośba dotycząca: FirestoreAdmin.GetDatabase
.
Pola | |
---|---|
name |
To pole jest wymagane. Nazwa formularza |
Żądanie GetFieldRequest
Prośba dotycząca: FirestoreAdmin.GetField
.
Pola | |
---|---|
name |
To pole jest wymagane. Nazwa formularza |
Żądanie GetIndexRequest
Prośba dotycząca: FirestoreAdmin.GetIndex
.
Pola | |
---|---|
name |
To pole jest wymagane. Nazwa formularza |
Importuj metadane dokumentów
Metadane wyników dla zapytania google.longrunning.Operation
z FirestoreAdmin.ImportDocuments
.
Pola | |
---|---|
start_time |
Godzina rozpoczęcia tej operacji. |
end_time |
Czas zakończenia tej operacji. Wartość ta zostanie nieskonfigurowana, jeśli operacja jest w toku. |
operation_state |
Stan operacji importu. |
progress_documents |
Postęp tej operacji w dokumentach. |
progress_bytes |
Postęp tej operacji (w bajtach). |
collection_ids[] |
Identyfikatory kolekcji, które są importowane. |
input_uri_prefix |
Lokalizacja importowanych dokumentów. |
namespace_ids[] |
Identyfikatory przestrzeni nazw, które są importowane. |
Żądanie ImportDocumentsRequest
Prośba dotycząca: FirestoreAdmin.ImportDocuments
.
Pola | |
---|---|
name |
To pole jest wymagane. Baza danych, do której ma nastąpić import. Powinien mieć taki format: |
collection_ids[] |
Identyfikatory kolekcji do zaimportowania. Nieokreślone oznacza, że import obejmuje wszystkie kolekcje. |
input_uri_prefix |
Lokalizacja wyeksportowanych plików. Musi on być zgodny z parametrem „output_uri_prefix” atrybutu ExportDocumentsResponse z eksportu, który został ukończony. Zobacz: |
namespace_ids[] |
Pusta lista zawiera wszystkie przestrzenie nazw. Jest to preferowane użycie w przypadku baz danych, które nie korzystają z przestrzeni nazw. Pusty element ciągu to domyślna przestrzeń nazw. Należy go używać, jeśli baza danych zawiera dane w innych przestrzeniach nazw, ale nie chce 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. Ta nazwa indeksów złożonych będzie miała postać: |
query_scope |
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. |
api_scope |
Zakres interfejsu API obsługiwany przez ten indeks. |
fields[] |
Pola obsługiwane przez ten indeks. W przypadku indeksów złożonych wymaga to od 2 do 100 pól. Ostatni wpis w polu zawsze dotyczy ścieżki pola 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 |
Tylko dane wyjściowe. Stan obsługi indeksu. |
Zakres interfejsu API
Zakres interfejsu API określa interfejsy API (Firestore natywne lub Firestore w trybie Datastore), które są obsługiwane w przypadku zapytań.
Wartości w polu enum | |
---|---|
ANY_API |
Z indeksu może korzystać tylko interfejs natywnego interfejsu Firestore Native Query API. Jest to ustawienie domyślne. |
DATASTORE_MODE_API |
Z indeksu może korzystać tylko Firestore w interfejsie API zapytań trybu Datastore. |
Pole indeksu
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 |
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 |
Wskazuje, że to pole umożliwia 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ższego sąsiada i operacje 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 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. |
Konfiguracja wektorów
Konfiguracja indeksu do obsługi operacji wyszukiwania wektorowych
Pola | |
---|---|
dimension |
To pole jest wymagane. Wymiar wektorowy, którego dotyczy ta konfiguracja. Powstały indeks będzie zawierał tylko wektory tego wymiaru i można go używać do wyszukiwania wektorowego z tym samym wymiarem. |
Pole sumy type . Typ użytego indeksu. type może być tylko jedną z tych wartości: |
|
flat |
Wskazuje, że indeks wektorów jest indeksem płaskim. |
Płaski indeks
Ten typ nie ma żadnych pól.
Indeks, który przechowuje wektory w płaskiej strukturze danych i obsługuje szczegółowe wyszukiwanie.
Zakres zapytania
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. |
COLLECTION_RECURSIVE |
Uwzględnij w indeksie wszystkich elementów nadrzędnych kolekcji. Dostępne tylko dla baz danych trybu Datastore. |
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. |
Metadane operacji indeksu
Metadane wyników dla zapytania google.longrunning.Operation
z FirestoreAdmin.CreateIndex
.
Pola | |
---|---|
start_time |
Godzina rozpoczęcia tej operacji. |
end_time |
Czas zakończenia tej operacji. Wartość ta zostanie nieskonfigurowana, jeśli operacja jest w toku. |
index |
Zasób indeksu, na którym 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świetl żądanie harmonogramu tworzenia kopii zapasowych
Prośba dotycząca: FirestoreAdmin.ListBackupSchedules
.
Pola | |
---|---|
parent |
To pole jest wymagane. Nadrzędna baza danych. Format: |
Wyświetlenie odpowiedzi na harmonogram tworzenia kopii zapasowych
Odpowiedź dotycząca: FirestoreAdmin.ListBackupSchedules
.
Pola | |
---|---|
backup_schedules[] |
Lista wszystkich harmonogramów tworzenia kopii zapasowych. |
Wyświetlanie żądań kopii zapasowych
Prośba dotycząca: FirestoreAdmin.ListBackups
.
Pola | |
---|---|
parent |
To pole jest wymagane. Lokalizacja, z której wyświetlane są kopie zapasowe. Format: |
Wyświetlanie odpowiedzi na kopie zapasowe
Odpowiedź dotycząca: 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 blokować całe żądania, gdy dana lokalizacja jest nieosiągalna, ta odpowiedź zwraca częściowy zbiór wyników i listę lokalizacji, do których nie można dotrzeć. Można ponowić żądanie dla pojedynczej lokalizacji, aby uzyskać konkretny błąd. |
Wyświetlanie żądań baz danych
Żądanie wyświetlenia listy baz danych Firestore we wszystkich lokalizacjach projektu.
Pola | |
---|---|
parent |
To pole jest wymagane. Nazwa elementu nadrzędnego formularza |
show_deleted |
Jeśli ma wartość true (prawda), zwraca także usunięte zasoby. |
Wyświetlanie odpowiedzi na listę baz danych
Lista baz danych projektu.
Pola | |
---|---|
databases[] |
Bazy danych w projekcie. |
unreachable[] |
Jeśli nie można wyświetlić danych o poszczególnych bazach danych, zostaną one zapisane tutaj. Przykładowy wpis może wyglądać tak: projects/jakiś_projekt/lokalizacje/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 szczegółów dotyczących bazy danych. Aby uzyskać bardziej szczegółowy komunikat o błędzie (lub pobrać zasób), możesz wysłać żądanie „Get” dla zasobu lub „List” dla konkretnej lokalizacji. |
Żądanie ListFields
Prośba dotycząca: FirestoreAdmin.ListFields
.
Pola | |
---|---|
parent |
To pole jest wymagane. Nazwa elementu nadrzędnego formularza |
filter |
Filtr, który zostanie zastosowany do wyników z listy. Obecnie |
page_size |
Liczba wyników do zwrócenia. |
page_token |
Token strony zwrócony z poprzedniego wywołania funkcji |
Odpowiedź na listę pól
Odpowiedź dotycząca: FirestoreAdmin.ListFields
.
Pola | |
---|---|
fields[] |
Wymagane pola. |
next_page_token |
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. |
Żądanie list indeksów
Prośba dotycząca: FirestoreAdmin.ListIndexes
.
Pola | |
---|---|
parent |
To pole jest wymagane. Nazwa elementu nadrzędnego formularza |
filter |
Filtr, który zostanie zastosowany do wyników z listy. |
page_size |
Liczba wyników do zwrócenia. |
page_token |
Token strony zwrócony z poprzedniego wywołania funkcji |
Odpowiedź na liście indeksów
Odpowiedź dotycząca: FirestoreAdmin.ListIndexes
.
Pola | |
---|---|
indexes[] |
Żądane indeksy. |
next_page_token |
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. |
Metadane lokalizacji
Ten typ nie ma żadnych pól.
Wiadomość z metadanymi dla google.cloud.location.Location.metadata
.
Stan operacji
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 |
Szacunkowy nakład pracy. |
completed_work |
Ilość wykonanych zadań. |
Przywracanie metadanych bazy danych
Metadane obiektu long-running operation
z żądania [RestoreDatabase][google.firestore.admin.v1.RestoreDatabase].
Pola | |
---|---|
start_time |
Godzina rozpoczęcia przywracania. |
end_time |
Czas zakończenia przywracania, nieokreślony w przypadku trwających przywracania. |
operation_state |
Stan operacji przywracania. |
database |
Nazwa bazy danych, do której przywracasz dane. |
backup |
Nazwa kopii zapasowej, z której jest przywracana. |
progress_percentage |
Długość czasu przywracania to szacowany odsetek pozostałego czasu. |
Żądanie przywrócenia bazy danych
Komunikat żądania dotyczący [FirestoreAdmin.RestoreDatabase][google.firestore.admin.v1.RestoreDatabase].
Pola | |
---|---|
parent |
To pole jest wymagane. Projekt, w którym chcesz przywrócić bazę danych. Format: |
database_id |
To pole jest wymagane. Identyfikator używany przez bazę 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. Powinna ona mieć od 4 do 63 znaków. Prawidłowe znaki to /[a-z][0-9]-/ , gdzie pierwszy znak to litera, a ostatnia litera lub cyfra. Nie może być jak identyfikator UUID /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. Identyfikator bazy danych „(domyślnie)” jest również prawidłowy. |
Pole sumy
|
|
backup |
Kopia zapasowa, z której chcesz przywrócić dane. Musi być z tego samego projektu co projekt nadrzędny. Format: |
Żądanie aktualizacji kopii zapasowej
Prośba dotycząca: FirestoreAdmin.UpdateBackupSchedule
.
Pola | |
---|---|
backup_schedule |
To pole jest wymagane. Harmonogram tworzenia kopii zapasowych do zaktualizowania. |
update_mask |
Lista pól do zaktualizowania. |
Aktualizowanie metadanych bazy danych
Ten typ nie ma żadnych pól.
Metadane związane z operacją aktualizacji bazy danych.
Żądanie aktualizacji bazy danych
Prośba dotycząca: FirestoreAdmin.UpdateDatabase
.
Pola | |
---|---|
database |
To pole jest wymagane. Baza danych do zaktualizowania. |
update_mask |
Lista pól do zaktualizowania. |
Żądanie aktualizacji pola
Prośba dotycząca: FirestoreAdmin.UpdateField
.
Pola | |
---|---|
field |
To pole jest wymagane. Pole do zaktualizowania. |
update_mask |
Maska powiązana z polem. Jeśli określisz konfigurację, w polu zostanie zaktualizowana tylko konfiguracja określona przez tę maskę pola. |
Powtarzanie tygodniowe
Reprezentuje cykliczny harmonogram, który jest uruchamiany w określonym dniu tygodnia.
Strefa czasowa to UTC.
Pola | |
---|---|
day |
Dzień tygodnia. Dzień DAY_OF_WEEK_UNSPECIFIED jest niedozwolony. |