Method: projects.databases.documents.batchWrite

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

O método documents.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 maneira independente. Consulte o BatchWriteResponse para saber o status de êxito de cada gravação.

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

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
database

string

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

Corpo da solicitação

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 gravações a serem aplicadas.

O método não aplica as gravações atomicamente e não garante a ordem. Cada gravação é bem-sucedida ou falha de maneira independente. Não é possível gravar no mesmo documento mais de uma vez por solicitação.
labels

map (key: string, value: string)

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

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

Corpo da resposta

A resposta de Firestore.BatchWrite.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

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

object (WriteResult)

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

Esse i-ésimo resultado de gravação corresponde à i-ésima gravação na solicitação.
status[]

object (Status)

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

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

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.