Method: projects.databases.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.

Żądanie HTTP

POST https://firestore.googleapis.com/v1/{name=projects/*/databases/*}:exportDocuments

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
name

string

Wymagane. Baza danych do wyeksportowania. Powinien mieć format: projects/{projectId}/databases/{databaseId}.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "collectionIds": [
    string
  ],
  "outputUriPrefix": string,
  "namespaceIds": [
    string
  ],
  "snapshotTime": string
}
Pola
collectionIds[]

string

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

string

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

string

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

string (Timestamp format)

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ż earliestVersionTime. Jeśli zostanie określony, wyeksportowane dokumenty będą reprezentować spójny widok bazy danych we wskazanym czasie. W przeciwnym razie nie ma gwarancji spójności wyeksportowanych dokumentów.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

Treść odpowiedzi

Jeśli operacja się uda, treść odpowiedzi będzie zawierała instancję Operation.

Zakresy autoryzacji

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

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

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