Class Batch (3.51.0)

Batch(session)

Accumulate mutations for transmission during commit.

Methods

__enter__()

Begin with block.

__exit__(exc_type, exc_val, exc_tb)

End with block.

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.