Method: projects.databases.importDocuments

Importe des documents dans Google Cloud Firestore. Les documents existants portant le même nom sont écrasés. L'importation s'effectue en arrière-plan. Sa progression peut être surveillée et gérée via la ressource "Operation" créée. Si une opération database.importDocuments est annulée, il est possible qu'un sous-ensemble des données ait déjà été importé dans Cloud Firestore.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Obligatoire. Base de données dans laquelle importer les données. 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
  ],
  "inputUriPrefix": string,
  "namespaceIds": [
    string
  ]
}
Champs
collectionIds[]

string

ID de collection à importer. "Non spécifié" signifie que toutes les collections incluses dans l'importation.
inputUriPrefix

string

Emplacement des fichiers exportés. Cet élément doit correspondre au préfixe outputUriPrefix d'une réponse ExportDocumentsResponse à partir d'une exportation qui s'est terminée avec succès. Consultez google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix.
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.

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.