Method: projects.databases.exportDocuments

Exportiert eine Kopie aller oder einer Teilmenge von Dokumenten aus dem Google Cloud Firestore in ein anderes Speichersystem, z. B. Google Cloud Storage. Letzte Aktualisierungen von Dokumenten werden möglicherweise nicht im Export berücksichtigt. Der Export erfolgt im Hintergrund und sein Fortschritt kann über die erstellte Operationsressource überwacht und verwaltet werden. Die Ausgabe eines Exports darf nur verwendet werden, wenn die zugehörige Operation ausgeführt wurde. Wenn ein Exportvorgang vor Abschluss abgebrochen wird, bleiben möglicherweise Teildaten in Google Cloud Storage zurück.

HTTP-Anfrage

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

Die URL verwendet die gRPC-Transcodierungssyntax .

Pfadparameter

Parameter
name

string

Zu exportierende Datenbank. Sollte die folgende Form haben: projects/{project_id}/databases/{databaseId} .

Text anfordern

Der Anforderungshauptteil enthält Daten mit folgender Struktur:

JSON-Darstellung
{
  "collectionIds": [
    string
  ],
  "outputUriPrefix": string
}
Felder
collectionIds[]

string

Welche Sammlungs-IDs exportiert werden sollen? Nicht spezifiziert bedeutet alle Sammlungen.

outputUriPrefix

string

Der Ausgabe-URI. Derzeit werden nur Google Cloud Storage-URIs der Form unterstützt: gs://BUCKET_NAME[/NAMESPACE_PATH] , wobei BUCKET_NAME der Name des Google Cloud Storage- NAMESPACE_PATH und NAMESPACE_PATH ein optionaler Google Cloud Storage-Namespace-Pfad ist. Beachten Sie bei der Auswahl eines Namens unbedingt die Namensrichtlinien für Google Cloud Storage: https://cloud.google.com/storage/docs/naming . Wenn der URI ein Bucket ist (ohne Namespace-Pfad), wird basierend auf der Startzeit ein Präfix generiert.

Antwortkörper

Bei Erfolg enthält der Antworttext eine Instanz von Operation .

Berechtigungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie in der Authentifizierungsübersicht .