Send feedback
Method: projects.databases.documents.commit
Stay organized with collections
Save and categorize content based on your preferences.
Commits a transaction, while optionally updating documents.
HTTP request
POST https://firestore.googleapis.com/v1/{database=projects/*/databases/*}/documents:commit
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters
database
string
Required. The database name. In the format: projects/{projectId}/databases/{databaseId}
.
Request body
The request body contains data with the following structure:
JSON representation
{
"writes" : [
{
object (Write
)
}
] ,
"transaction" : string
}
Fields
writes[]
object (Write
)
The writes to apply.
Always executed atomically and in order.
transaction
string (bytes format)
If set, applies all writes in this transaction, and commits it.
A base64-encoded string.
Response body
The response for Firestore.Commit
.
If successful, the response body contains data with the following structure:
JSON representation
{
"writeResults" : [
{
object (WriteResult
)
}
] ,
"commitTime" : string
}
Fields
writeResults[]
object (WriteResult
)
The result of applying the writes.
This i-th write result corresponds to the i-th write in the request.
commitTime
string (Timestamp
format)
The time at which the commit occurred. Any read with an equal or greater readTime
is guaranteed to see the effects of the commit.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z"
and "2014-10-02T15:01:23.045123456Z"
.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-04-12 UTC.
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"Missing the information I need"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"Too complicated / too many steps"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"Out of date"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"Samples / code issue"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
Need to tell us more?