Method: projects.databases.exportDocuments

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.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
name

string

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

Treść żądania

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

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

string

Identyfikatory kolekcji do wyeksportowania. Nieokreślone 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 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.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Operation.

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.