Method: projects.databases.documents.batchWrite

Aplica un lote de operaciones de escritura.

El método documents.batchWrite no aplica las operaciones de escritura de forma atómica y puede aplicarlas desordenadas. El método no permite más de una escritura por documento. Cada escritura tiene éxito o falla de forma independiente. Consulte BatchWriteResponse para conocer el estado correcto de cada escritura.

Si necesita un conjunto de escrituras aplicadas atómicamente, utilice documents.commit en su lugar.

solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación gRPC .

Parámetros de ruta

Parámetros
database

string

Requerido. El nombre de la base de datos. En el formato: projects/{projectId}/databases/{databaseId} .

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON
{
  "writes": [
    {
      object (Write)
    }
  ],
  "labels": {
    string: string,
    ...
  }
}
Campos
writes[]

object ( Write )

Los escritos para aplicar.

El método no se aplica, escribe de forma atómica y no garantiza el pedido. Cada escritura tiene éxito o falla de forma independiente. No puede escribir en el mismo documento más de una vez por solicitud.

labels

map (key: string, value: string)

Etiquetas asociadas con este lote de escritura.

Un objeto que contiene una lista de pares "key": value . Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

Cuerpo de respuesta

La respuesta de Firestore.BatchWrite .

Si tiene éxito, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON
{
  "writeResults": [
    {
      object (WriteResult)
    }
  ],
  "status": [
    {
      object (Status)
    }
  ]
}
Campos
writeResults[]

object ( WriteResult )

El resultado de aplicar las escrituras.

Este i-ésimo resultado de escritura corresponde a la i-ésima escritura en la solicitud.

status[]

object ( Status )

El estado de aplicación de las escrituras.

Este i-ésimo estado de escritura corresponde a la i-ésima escritura en la solicitud.

Ámbitos de autorización

Requiere uno de los siguientes ámbitos de OAuth:

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

Para obtener más información, consulte Descripción general de la autenticación .