Method: projects.databases.documents.batchWrite

Applique un lot d'opérations d'écriture.

La méthode documents.batchWrite n'applique pas les opérations d'écriture de manière atomique et peut les appliquer dans le désordre. La méthode ne permet pas plusieurs écritures par document. Chaque écriture réussit ou échoue indépendamment. Consultez BatchWriteResponse pour connaître l'état de réussite de chaque écriture.

Si vous avez besoin d'un ensemble d'écritures appliqué de manière atomique, utilisez plutôt documents.commit.

Requête HTTP

POST https://firestore.googleapis.com/v1/{database=projects/*/databases/*}/documents:batchWrite

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
database

string

Obligatoire. Nom de la base de données. Format à respecter: 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 
{
  "writes": [
    {
      object (Write)
    }
  ],
  "labels": {
    string: string,
    ...
  }
}
Champs
writes[]

object (Write)

Écritures à appliquer.

La méthode n'applique pas les écritures de manière atomique et ne garantit pas l'ordre. Chaque écriture réussit ou échoue indépendamment. Vous ne pouvez pas écrire dans le même document plusieurs fois par requête.
labels

map (key: string, value: string)

Étiquettes associées à cette écriture par lot.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Corps de la réponse

Réponse de Firestore.BatchWrite.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "writeResults": [
    {
      object (WriteResult)
    }
  ],
  "status": [
    {
      object (Status)
    }
  ]
}
Champs
writeResults[]

object (WriteResult)

Résultat de l'application des écritures.

Cette i-ième écriture correspond à l'i-ième écriture de la requête.
status[]

object (Status)

État de l'application des écritures.

Cet état d'écriture i-ième correspond à l'écriture i-ième dans la requête.

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.