Exporte une copie de tout ou partie des documents de Google Cloud Firestore vers un autre système de stockage, tel que Google Cloud Storage. Les mises à jour récentes des documents peuvent ne pas être reflétées dans l'exportation. L'exportation s'effectue en arrière-plan et sa progression peut être surveillée et gérée via la ressource Opération créée. Le résultat d’un export ne peut être utilisé qu’une fois l’opération associée effectuée. Si une opération d'exportation est annulée avant la fin, elle peut laisser des données partielles dans Google Cloud Storage.
Pour plus de détails sur le comportement d'exportation et le format de sortie, reportez-vous à : https://cloud.google.com/firestore/docs/manage-data/export-import
Requête HTTP
POST https://firestore.googleapis.com/v1/{name=projects/*/databases/*}:exportDocuments
L'URL utilise la syntaxe de transcodage gRPC .
Paramètres du chemin
Paramètres | |
---|---|
name | Requis. Base de données à exporter. Doit être de la forme : |
Corps de la demande
Le corps de la requête contient des données avec la structure suivante :
Représentation JSON |
---|
{ "collectionIds": [ string ], "outputUriPrefix": string, "namespaceIds": [ string ], "snapshotTime": string } |
Des champs | |
---|---|
collectionIds[] | Quels identifiants de collection exporter. Non spécifié signifie toutes les collections. |
outputUriPrefix | L’URI de sortie. Actuellement, ne prend en charge que les URI Google Cloud Storage de la forme : |
namespaceIds[] | Une liste vide représente tous les espaces de noms. Il s'agit de l'utilisation préférée pour les bases de données qui n'utilisent pas d'espaces de noms. Un élément de chaîne vide représente l'espace de noms par défaut. Cela doit être utilisé si la base de données contient des données dans des espaces de noms autres que ceux par défaut, mais ne souhaite pas les inclure. Chaque espace de noms de cette liste doit être unique. |
snapshotTime | L'horodatage qui correspond à la version de la base de données à exporter. L'horodatage doit être antérieur, arrondi à la minute près et ne doit pas être antérieur à Un horodatage au format RFC3339 UTC "Zulu", avec une résolution en nanosecondes et jusqu'à neuf chiffres fractionnaires. Exemples : |
Corps de réponse
En cas de succès, le corps de la réponse contient une instance de Operation
.
Portées des autorisations
Nécessite l'une des étendues OAuth suivantes :
-
https://www.googleapis.com/auth/datastore
-
https://www.googleapis.com/auth/cloud-platform
Pour plus d'informations, consultez la Présentation de l'authentification .