Class Batch (3.50.1)

Version latest

• 3.50.1 (latest)
• 3.50.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.1
• 3.39.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.1
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.27.1
• 3.26.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.2
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.1
• 3.14.1
• 3.13.0
• 3.12.1
• 3.11.1
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.1.1
• 2.0.0
• 1.19.3
• 1.18.0
• 1.17.1
• 1.16.0
• 1.15.1
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0

Batch(session)

Accumulate mutations for transmission during commit.

Methods

__enter__

__enter__()

Begin with block.

__exit__

__exit__(exc_type, exc_val, exc_tb)

End with block.

commit

commit(
    return_commit_stats=False,
    request_options=None,
    max_commit_delay=None,
    exclude_txn_from_change_streams=False,
)

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.

Returns
Type	Description
datetime	timestamp of the committed changes.