Send feedback
Class Batch (3.57.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latestkeyboard_arrow_down
Accumulate mutations for transmission during commit
.
Methods
__enter__
__exit__
__exit__ ( exc_type , exc_val , exc_tb )
commit
commit (
return_commit_stats = False ,
request_options = None ,
max_commit_delay = None ,
exclude_txn_from_change_streams = False ,
isolation_level = IsolationLevel . ISOLATION_LEVEL_UNSPECIFIED ,
timeout_secs = 30 ,
default_retry_delay = None ,
)
Commit mutations to the database.
Parameters
Name
Description
return_commit_stats
bool
If true, the response will return commit stats which can be accessed though commit_stats.
request_options
RequestOptions
(Optional) Common options for this request. If a dict is provided, it must be of the same form as the protobuf message RequestOptions .
max_commit_delay
datetime.timedelta
(Optional) The amount of latency this request is willing to incur in order to improve throughput.
exclude_txn_from_change_streams
bool
(Optional) If true, instructs the transaction to be excluded from being recorded in change streams with the DDL option allow_txn_exclusion=true
. This does not exclude the transaction from being recorded in the change streams with the DDL option allow_txn_exclusion
being false or unset.
isolation_level
IsolationLevel
(Optional) Sets isolation level for the transaction.
timeout_secs
int
(Optional) The default time in seconds to wait before re-trying the commit..
Exceptions
Type
Description
ValueError
if the transaction is not ready to commit.
Returns
Type
Description
datetime
timestamp of the committed changes.
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 2025-08-28 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Class Batch (3.57.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.57.0 (latest)](/python/docs/reference/spanner/latest/google.cloud.spanner_v1.batch.Batch)\n- [3.56.0](/python/docs/reference/spanner/3.56.0/google.cloud.spanner_v1.batch.Batch)\n- [3.55.0](/python/docs/reference/spanner/3.55.0/google.cloud.spanner_v1.batch.Batch)\n- [3.54.0](/python/docs/reference/spanner/3.54.0/google.cloud.spanner_v1.batch.Batch)\n- [3.53.0](/python/docs/reference/spanner/3.53.0/google.cloud.spanner_v1.batch.Batch)\n- [3.52.0](/python/docs/reference/spanner/3.52.0/google.cloud.spanner_v1.batch.Batch)\n- [3.51.0](/python/docs/reference/spanner/3.51.0/google.cloud.spanner_v1.batch.Batch)\n- [3.50.1](/python/docs/reference/spanner/3.50.1/google.cloud.spanner_v1.batch.Batch)\n- [3.46.0](/python/docs/reference/spanner/3.46.0/google.cloud.spanner_v1.batch.Batch)\n- [3.45.0](/python/docs/reference/spanner/3.45.0/google.cloud.spanner_v1.batch.Batch)\n- [3.44.0](/python/docs/reference/spanner/3.44.0/google.cloud.spanner_v1.batch.Batch)\n- [3.43.0](/python/docs/reference/spanner/3.43.0/google.cloud.spanner_v1.batch.Batch)\n- [3.42.0](/python/docs/reference/spanner/3.42.0/google.cloud.spanner_v1.batch.Batch)\n- [3.41.0](/python/docs/reference/spanner/3.41.0/google.cloud.spanner_v1.batch.Batch)\n- [3.40.1](/python/docs/reference/spanner/3.40.1/google.cloud.spanner_v1.batch.Batch)\n- [3.39.0](/python/docs/reference/spanner/3.39.0/google.cloud.spanner_v1.batch.Batch)\n- [3.38.0](/python/docs/reference/spanner/3.38.0/google.cloud.spanner_v1.batch.Batch)\n- [3.37.0](/python/docs/reference/spanner/3.37.0/google.cloud.spanner_v1.batch.Batch)\n- [3.36.0](/python/docs/reference/spanner/3.36.0/google.cloud.spanner_v1.batch.Batch)\n- [3.35.1](/python/docs/reference/spanner/3.35.1/google.cloud.spanner_v1.batch.Batch)\n- [3.34.0](/python/docs/reference/spanner/3.34.0/google.cloud.spanner_v1.batch.Batch)\n- [3.33.0](/python/docs/reference/spanner/3.33.0/google.cloud.spanner_v1.batch.Batch)\n- [3.32.0](/python/docs/reference/spanner/3.32.0/google.cloud.spanner_v1.batch.Batch)\n- [3.31.0](/python/docs/reference/spanner/3.31.0/google.cloud.spanner_v1.batch.Batch)\n- [3.30.0](/python/docs/reference/spanner/3.30.0/google.cloud.spanner_v1.batch.Batch)\n- [3.29.0](/python/docs/reference/spanner/3.29.0/google.cloud.spanner_v1.batch.Batch)\n- [3.28.0](/python/docs/reference/spanner/3.28.0/google.cloud.spanner_v1.batch.Batch)\n- [3.27.1](/python/docs/reference/spanner/3.27.1/google.cloud.spanner_v1.batch.Batch)\n- [3.26.0](/python/docs/reference/spanner/3.26.0/google.cloud.spanner_v1.batch.Batch)\n- [3.25.0](/python/docs/reference/spanner/3.25.0/google.cloud.spanner_v1.batch.Batch)\n- [3.24.0](/python/docs/reference/spanner/3.24.0/google.cloud.spanner_v1.batch.Batch)\n- [3.23.0](/python/docs/reference/spanner/3.23.0/google.cloud.spanner_v1.batch.Batch)\n- [3.22.2](/python/docs/reference/spanner/3.22.2/google.cloud.spanner_v1.batch.Batch)\n- [3.21.0](/python/docs/reference/spanner/3.21.0/google.cloud.spanner_v1.batch.Batch)\n- [3.20.0](/python/docs/reference/spanner/3.20.0/google.cloud.spanner_v1.batch.Batch)\n- [3.19.0](/python/docs/reference/spanner/3.19.0/google.cloud.spanner_v1.batch.Batch)\n- [3.18.0](/python/docs/reference/spanner/3.18.0/google.cloud.spanner_v1.batch.Batch)\n- [3.17.0](/python/docs/reference/spanner/3.17.0/google.cloud.spanner_v1.batch.Batch)\n- [3.16.0](/python/docs/reference/spanner/3.16.0/google.cloud.spanner_v1.batch.Batch)\n- [3.15.1](/python/docs/reference/spanner/3.15.1/google.cloud.spanner_v1.batch.Batch)\n- [3.14.1](/python/docs/reference/spanner/3.14.1/google.cloud.spanner_v1.batch.Batch)\n- [3.13.0](/python/docs/reference/spanner/3.13.0/google.cloud.spanner_v1.batch.Batch)\n- [3.12.1](/python/docs/reference/spanner/3.12.1/google.cloud.spanner_v1.batch.Batch)\n- [3.11.1](/python/docs/reference/spanner/3.11.1/google.cloud.spanner_v1.batch.Batch)\n- [3.10.0](/python/docs/reference/spanner/3.10.0/google.cloud.spanner_v1.batch.Batch)\n- [3.9.0](/python/docs/reference/spanner/3.9.0/google.cloud.spanner_v1.batch.Batch)\n- [3.8.0](/python/docs/reference/spanner/3.8.0/google.cloud.spanner_v1.batch.Batch)\n- [3.7.0](/python/docs/reference/spanner/3.7.0/google.cloud.spanner_v1.batch.Batch)\n- [3.6.0](/python/docs/reference/spanner/3.6.0/google.cloud.spanner_v1.batch.Batch)\n- [3.5.0](/python/docs/reference/spanner/3.5.0/google.cloud.spanner_v1.batch.Batch)\n- [3.4.0](/python/docs/reference/spanner/3.4.0/google.cloud.spanner_v1.batch.Batch)\n- [3.3.0](/python/docs/reference/spanner/3.3.0/google.cloud.spanner_v1.batch.Batch)\n- [3.2.0](/python/docs/reference/spanner/3.2.0/google.cloud.spanner_v1.batch.Batch)\n- [3.1.0](/python/docs/reference/spanner/3.1.0/google.cloud.spanner_v1.batch.Batch)\n- [3.0.0](/python/docs/reference/spanner/3.0.0/google.cloud.spanner_v1.batch.Batch)\n- [2.1.1](/python/docs/reference/spanner/2.1.1/google.cloud.spanner_v1.batch.Batch)\n- [2.0.0](/python/docs/reference/spanner/2.0.0/google.cloud.spanner_v1.batch.Batch)\n- [1.19.3](/python/docs/reference/spanner/1.19.3/google.cloud.spanner_v1.batch.Batch)\n- [1.18.0](/python/docs/reference/spanner/1.18.0/google.cloud.spanner_v1.batch.Batch)\n- [1.17.1](/python/docs/reference/spanner/1.17.1/google.cloud.spanner_v1.batch.Batch)\n- [1.16.0](/python/docs/reference/spanner/1.16.0/google.cloud.spanner_v1.batch.Batch)\n- [1.15.1](/python/docs/reference/spanner/1.15.1/google.cloud.spanner_v1.batch.Batch)\n- [1.14.0](/python/docs/reference/spanner/1.14.0/google.cloud.spanner_v1.batch.Batch)\n- [1.13.0](/python/docs/reference/spanner/1.13.0/google.cloud.spanner_v1.batch.Batch)\n- [1.12.0](/python/docs/reference/spanner/1.12.0/google.cloud.spanner_v1.batch.Batch)\n- [1.11.0](/python/docs/reference/spanner/1.11.0/google.cloud.spanner_v1.batch.Batch)\n- [1.10.0](/python/docs/reference/spanner/1.10.0/google.cloud.spanner_v1.batch.Batch) \n\n Batch(session)\n\nAccumulate mutations for transmission during `commit`.\n\nMethods\n-------\n\n### __enter__\n\n __enter__()\n\nBegin `with` block.\n\n### __exit__\n\n __exit__(exc_type, exc_val, exc_tb)\n\nEnd `with` block.\n\n### commit\n\n commit(\n return_commit_stats=False,\n request_options=None,\n max_commit_delay=None,\n exclude_txn_from_change_streams=False,\n isolation_level=IsolationLevel.ISOLATION_LEVEL_UNSPECIFIED,\n timeout_secs=30,\n default_retry_delay=None,\n )\n\nCommit mutations to the database."]]