Batches

Helpers for batch requests to the Google Cloud Firestore API.

class google.cloud.firestore_v1.batch.WriteBatch(client)

Bases: google.cloud.firestore_v1.base_batch.BaseWriteBatch

Accumulate write operations to be sent in a batch.

This has the same set of methods for write operations that DocumentReference does, e.g. create() .

• Parameters

  client( Client ) – The client that created this batch.

commit(retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

Commit the changes accumulated in this batch.

• Parameters

  • 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

  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.

• Return type

  List[ google.cloud.proto.firestore.v1.write.WriteResult , …]