Class WriteBatch (2.7.1)

Version 2.7.1

• 2.19.0 (latest)
• 2.18.0
• 2.17.2
• 2.16.1
• 2.15.0
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.1
• 2.10.1
• 2.9.1
• 2.8.0
• 2.7.3
• 2.6.1
• 2.5.3
• 2.4.0
• 2.3.4
• 2.2.0
• 2.1.3
• 2.0.2
• 1.9.2
• 1.8.1
• 1.7.0
• 1.6.2
• 1.5.0
• 1.4.0
• 1.3.0

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.

Inheritance

builtins.object > BaseBatch > BaseWriteBatch > WriteBatch

Methods

commit

commit(retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None)

Commit 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.