Commits a transaction, while optionally updating documents.
Arguments
Parameters | |
---|---|
database |
Required. The database name. In the format:
|
body |
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 CommitResponse
.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation.
YAML
- commit: call: googleapis.firestore.v1.projects.databases.documents.commit args: database: ... body: transaction: ... writes: ... result: commitResult
JSON
[ { "commit": { "call": "googleapis.firestore.v1.projects.databases.documents.commit", "args": { "database": "...", "body": { "transaction": "...", "writes": "..." } }, "result": "commitResult" } } ]