Method: projects.databases.exportDocuments

Exporte une copie de tout ou d'un sous-ensemble des documents de Google Cloud Firestore vers un autre système de stockage, tel que Google Cloud Storage. Il est possible que les modifications récentes apportées aux documents ne soient pas 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 "Operation" créée. Le résultat d'une exportation ne peut être utilisé qu'une fois l'opération associée terminée. Si une opération d'exportation est annulée avant qu'elle ne soit terminée, des données partielles peuvent être laissées dans Google Cloud Storage.

Pour en savoir plus sur le comportement des exportations et le format de sortie, consultez la page 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 de chemin d'accès

Paramètres
name

string

Obligatoire. Base de données à exporter. Doit être au format suivant: projects/{projectId}/databases/{databaseId}.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "collectionIds": [
    string
  ],
  "outputUriPrefix": string,
  "namespaceIds": [
    string
  ],
  "snapshotTime": string
}
Champs
collectionIds[]

string

ID de collection à exporter. "Non spécifié" signifie que toutes les collections.
outputUriPrefix

string

URI de sortie. Actuellement, seuls les URI Google Cloud Storage au format suivant sont acceptés: gs://BUCKET_NAME[/NAMESPACE_PATH], où BUCKET_NAME est le nom du bucket Google Cloud Storage et NAMESPACE_PATH est un chemin d'accès facultatif à l'espace de noms Google Cloud Storage. Lorsque vous choisissez un nom, tenez compte des consignes de dénomination de Google Cloud Storage: https://cloud.google.com/storage/docs/naming. Si l'URI est un bucket (sans chemin d'espace de noms), un préfixe est généré en fonction de l'heure de début.
namespaceIds[]

string

Une liste vide représente tous les espaces de noms. Il s'agit de l'utilisation privilégié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. Utilisez ce paramètre 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

string (Timestamp format)

Code temporel correspondant à la version de la base de données à exporter. Le code temporel doit être dans le passé, arrondi à la minute et ne doit pas être antérieur à earliestVersionTime. Si cette option est spécifiée, les documents exportés représenteront une vue cohérente de la base de données au moment indiqué. Sinon, la cohérence des documents exportés n'est pas garantie.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres après la virgule. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Operation.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez la page Présentation de l'authentification.