Method: googleapis.firestore.v1beta1.projects.databases.documents.batchWrite

Applies a batch of write operations. The BatchWrite method does not apply the write operations atomically and can apply them out of order. Method does not allow more than one write per document. Each write succeeds or fails independently. See the BatchWriteResponse for the success status of each write. If you require an atomically applied set of writes, use Commit instead.

Arguments

Parameters
database

string

Required. The database name. In the format: projects/{project_id}/databases/{database_id}.
body

object (BatchWriteRequest)

Required.

Raised exceptions

Exceptions
ConnectionError In case of a network problem (such as DNS failure or refused connection).
HttpError If the response status is >= 400 (excluding 429 and 503).
TimeoutError If a long-running operation takes longer to finish than the specified timeout limit.
TypeError If an operation or function receives an argument of the wrong type.
ValueError If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of BatchWriteResponse.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- batchWrite:
    call: googleapis.firestore.v1beta1.projects.databases.documents.batchWrite
    args:
        database: ...
        body:
            labels: ...
            writes: ...
    result: batchWriteResult

JSON

[
  {
    "batchWrite": {
      "call": "googleapis.firestore.v1beta1.projects.databases.documents.batchWrite",
      "args": {
        "database": "...",
        "body": {
          "labels": "...",
          "writes": "..."
        }
      },
      "result": "batchWriteResult"
    }
  }
]