Method: projects.databases.documents.batchWrite

Aplica um lote de operações de gravação.

O métododocuments.batchWrite não aplica as operações de gravação atomicamente e pode aplicá-las fora de ordem. O método não permite mais de uma gravação por documento. Cada gravação é bem-sucedida ou falha de forma independente. Consulte BatchWriteResponse para obter o status de sucesso de cada gravação.

Se você precisar de um conjunto de gravações aplicadas atomicamente, use documents.commit .

Solicitação HTTP

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

A URL usa sintaxe de transcodificação gRPC .

Parâmetros de caminho

Parâmetros
database

string

Obrigatório. O nome do banco de dados. No formato: projects/{projectId}/databases/{databaseId} .

Solicitar corpo

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON
{
  "writes": [
    {
      object (Write)
    }
  ],
  "labels": {
    string: string,
    ...
  }
}
Campos
writes[]

object ( Write )

As escritas para aplicar.

O método não aplica gravações atomicamente e não garante a ordenação. Cada gravação é bem-sucedida ou falha de forma independente. Você não pode gravar no mesmo documento mais de uma vez por solicitação.

labels

map (key: string, value: string)

Rótulos associados a esta gravação em lote.

Um objeto que contém uma lista de pares "key": value . Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

Corpo de resposta

A resposta de Firestore.BatchWrite .

Se for bem-sucedido, o corpo da resposta conterá dados com a seguinte estrutura:

Representação JSON
{
  "writeResults": [
    {
      object (WriteResult)
    }
  ],
  "status": [
    {
      object (Status)
    }
  ]
}
Campos
writeResults[]

object ( WriteResult )

O resultado da aplicação das gravações.

Este i-ésimo resultado de gravação corresponde à i-ésima gravação na solicitação.

status[]

object ( Status )

O status de aplicação das gravações.

Este i-ésimo status de gravação corresponde à i-ésima gravação na solicitação.

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .