Class WriteBatch (1.7.0)

Version 1.7.0

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

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()

Commit the changes accumulated in this batch.

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.

create

create(reference, document_data)

Add a "change" to this batch to create a document.

If the document given by reference already exists, then this batch will fail when commit-ed.

Parameters
Name	Description
reference	DocumentReference A document reference to be created in this batch.
document_data	dict Property names and values to use for creating a document.

delete

delete(reference, option=None)

Add a "change" to delete a document.

See xref_delete for more information on how option determines how the change is applied.

Parameters
Name	Description
reference	DocumentReference A document reference that will be deleted in this batch.
option	Optional[WriteOption] A write option to make assertions / preconditions on the server state of the document before applying changes.

set

set(reference, document_data, merge=False)

Add a "change" to replace a document.

See xref_set for more information on how option determines how the change is applied.

Parameters
Name	Description
reference	DocumentReference A document reference that will have values set in this batch.
document_data	dict Property names and values to use for replacing a document.
merge	Optional[bool] or Optional[List If True, apply merging instead of overwriting the state of the document.

update

update(reference, field_updates, option=None)

Add a "change" to update a document.

See xref_update for more information on field_updates and option.

Parameters
Name	Description
reference	DocumentReference A document reference that will be updated in this batch.
field_updates	dict Field names or paths to update and values to update with.
option	Optional[WriteOption] A write option to make assertions / preconditions on the server state of the document before applying changes.