Method: projects.databases.exportDocuments

Exportiert eine Kopie aller oder eines Teils von Dokumenten von Google Cloud Firestore in ein anderes Speichersystem wie Google Cloud Storage. Kürzlich an Dokumenten vorgenommene Aktualisierungen werden möglicherweise nicht im Export berücksichtigt. Der Export wird im Hintergrund ausgeführt und der Fortschritt kann über die erstellte Vorgangsressource überwacht und verwaltet werden. Die Ausgabe eines Exports kann erst verwendet werden, nachdem der zugehörige Vorgang abgeschlossen ist. Wenn ein Exportvorgang vor dem Abschluss abgebrochen wird, bleiben möglicherweise unvollständige Daten in Google Cloud Storage erhalten.

Weitere Informationen zum Exportverhalten und zum Ausgabeformat finden Sie unter https://cloud.google.com/firestore/docs/manage-data/export-import.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
name

string

Erforderlich. Zu exportierende Datenbank. Muss das Format projects/{projectId}/databases/{databaseId} haben.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

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

string

Die zu exportierenden Sammlungs-IDs. „Nicht angegeben“ bedeutet alle Sammlungen.
outputUriPrefix

string

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

string

Eine leere Liste stellt alle Namespaces dar. Dies ist die bevorzugte Verwendung für Datenbanken, die keine Namespaces verwenden.

Ein leeres Stringelement stellt den Standard-Namespace dar. Dies sollte verwendet werden, wenn die Datenbank Daten in nicht standardmäßigen Namespaces enthält, diese aber nicht einschließen möchte. Jeder Namespace in dieser Liste muss eindeutig sein.
snapshotTime

string (Timestamp format)

Der Zeitstempel, der der Version der zu exportierenden Datenbank entspricht. Der Zeitstempel muss in der Vergangenheit liegen, auf die Minute gerundet sein und darf nicht älter als earliestVersionTime sein. Wenn angegeben, stellen die exportierten Dokumente eine einheitliche Ansicht der Datenbank zum angegebenen Zeitpunkt dar. Andernfalls gibt es keine Garantie für die Konsistenz der exportierten Dokumente.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Operation.

Autorisierungsbereiche

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.