Aplica un lote de operaciones de escritura.
El método document.batchWrite no aplica las operaciones de escritura de manera atómica y puede aplicarlas desordenadamente. El método no permite más de una escritura por documento. Cada escritura se realiza correctamente o falla de forma independiente. Consulta BatchWriteResponse
para conocer el estado de éxito de cada escritura.
Si necesitas un conjunto de escrituras aplicado de forma atómica, usa documents.commit
en su lugar.
Solicitud HTTP
POST https://firestore.googleapis.com/v1/{database=projects/*/databases/*}/documents:batchWrite
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
Parámetros | |
---|---|
database |
Obligatorio. Es el nombre de la base de datos. En el formato: |
Cuerpo de la solicitud
El cuerpo de la solicitud contiene datos con la siguiente estructura:
Representación JSON |
---|
{
"writes": [
{
object ( |
Campos | |
---|---|
writes[] |
Las operaciones de escritura que se aplicarán. El método no aplica escrituras de forma atómica y no garantiza el orden. Cada escritura se realiza correctamente o falla de forma independiente. No puedes escribir en el mismo documento más de una vez por solicitud. |
labels |
Las etiquetas asociadas con esta escritura por lotes. Es un objeto que contiene una lista de pares |
Cuerpo de la respuesta
Es la respuesta de Firestore.BatchWrite
.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
Representación JSON |
---|
{ "writeResults": [ { object ( |
Campos | |
---|---|
writeResults[] |
Es el resultado de aplicar las operaciones de escritura. Este resultado de escritura de i-th corresponde a la escritura de i-ésima en la solicitud. |
status[] |
El estado de aplicación de las operaciones de escritura. Este estado de escritura de i-th corresponde a la de escritura de i-ésima en la solicitud. |
Permisos de autorización
Se necesita uno de los siguientes alcances de OAuth:
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
Para obtener más información, consulta Descripción general de la autenticación.