Class WriteBatch (2.17.2)
Stay organized with collections
Save and categorize content based on your preferences.
WriteBatch(client)Accumulate write operations to be sent in a batch. Use this over
BulkWriteBatch for lower volumes or when the order of operations
within a given batch is important.
This has the same set of methods for write operations that xref_DocumentReference does, e.g. xref_create.
Parameter |
|
|---|---|
| Name | Description |
client |
Client
The client that created this batch. |
Methods
commit
commit(
retry: google.api_core.retry.retry_unary.Retry = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Optional[float] = None,
) -> listCommit the changes accumulated in this batch.
| Parameters | |
|---|---|
| Name | Description |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. Defaults to a system-specified policy. |
timeout |
float
The timeout for this request. Defaults to a system-specified value. |
| Returns | |
|---|---|
| Type | Description |
List[WriteResult, ...] |
The write results corresponding to the changes committed, returned in the same order as the changes were applied to this batch. A write result contains an update_time field. |