A write batch, used to perform multiple writes as a single atomic unit.
A WriteBatch object can be acquired by calling writeBatch(). It provides methods for adding writes to the write batch. None of the writes will be committed (or visible locally) until WriteBatch.commit() is called.
Signature:
export declare class WriteBatch
Methods
| Method | Modifiers | Description |
|---|---|---|
| commit() | Commits all of the writes in this write batch as a single atomic unit.The result of these writes will only be reflected in document reads that occur after the returned promise resolves. If the client is offline, the write fails. If you would like to see local modifications or buffer writes until the client is online, use the full Firestore SDK. | |
| delete(documentRef) | Deletes the document referred to by the provided DocumentReference. | |
| set(documentRef, data) | Writes to the document referred to by the provided DocumentReference. If the document does not exist yet, it will be created. | |
| set(documentRef, data, options) | Writes to the document referred to by the provided DocumentReference. If the document does not exist yet, it will be created. If you provide merge or mergeFields, the provided data can be merged into an existing document. |
|
| update(documentRef, data) | Updates fields in the document referred to by the provided DocumentReference. The update will fail if applied to a document that does not exist. | |
| update(documentRef, field, value, moreFieldsAndValues) | Updates fields in the document referred to by this DocumentReference. The update will fail if applied to a document that does not exist.Nested fields can be update by providing dot-separated field path strings or by providing FieldPath objects. |
WriteBatch.commit()
Commits all of the writes in this write batch as a single atomic unit.
The result of these writes will only be reflected in document reads that occur after the returned promise resolves. If the client is offline, the write fails. If you would like to see local modifications or buffer writes until the client is online, use the full Firestore SDK.
Signature:
commit(): Promise<void>;
Returns:
Promise<void>
A Promise resolved once all of the writes in the batch have been successfully written to the backend as an atomic unit (note that it won't resolve while you're offline).
WriteBatch.delete()
Deletes the document referred to by the provided DocumentReference.
Signature:
delete<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): WriteBatch;
Parameters
| Parameter | Type | Description |
|---|---|---|
| documentRef | DocumentReference<AppModelType, DbModelType> | A reference to the document to be deleted. |
Returns:
This WriteBatch instance. Used for chaining method calls.
WriteBatch.set()
Writes to the document referred to by the provided DocumentReference. If the document does not exist yet, it will be created.
Signature:
set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): WriteBatch;
Parameters
| Parameter | Type | Description |
|---|---|---|
| documentRef | DocumentReference<AppModelType, DbModelType> | A reference to the document to be set. |
| data | WithFieldValue<AppModelType> | An object of the fields and values for the document. |
Returns:
This WriteBatch instance. Used for chaining method calls.
WriteBatch.set()
Writes to the document referred to by the provided DocumentReference. If the document does not exist yet, it will be created. If you provide merge or mergeFields, the provided data can be merged into an existing document.
Signature:
set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): WriteBatch;
Parameters
| Parameter | Type | Description |
|---|---|---|
| documentRef | DocumentReference<AppModelType, DbModelType> | A reference to the document to be set. |
| data | PartialWithFieldValue<AppModelType> | An object of the fields and values for the document. |
| options | SetOptions | An object to configure the set behavior. |
Returns:
This WriteBatch instance. Used for chaining method calls.
Exceptions
Error - If the provided input is not a valid Firestore document.
WriteBatch.update()
Updates fields in the document referred to by the provided DocumentReference. The update will fail if applied to a document that does not exist.
Signature:
update<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): WriteBatch;
Parameters
| Parameter | Type | Description |
|---|---|---|
| documentRef | DocumentReference<AppModelType, DbModelType> | A reference to the document to be updated. |
| data | UpdateData<DbModelType> | An object containing the fields and values with which to update the document. Fields can contain dots to reference nested fields within the document. |
Returns:
This WriteBatch instance. Used for chaining method calls.
Exceptions
Error - If the provided input is not valid Firestore data.
WriteBatch.update()
Updates fields in the document referred to by this DocumentReference. The update will fail if applied to a document that does not exist.
Nested fields can be update by providing dot-separated field path strings or by providing FieldPath objects.
Signature:
update<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): WriteBatch;
Parameters
| Parameter | Type | Description |
|---|---|---|
| documentRef | DocumentReference<AppModelType, DbModelType> | A reference to the document to be updated. |
| field | string | FieldPath | The first field to update. |
| value | unknown | The first value. |
| moreFieldsAndValues | unknown[] | Additional key value pairs. |
Returns:
This WriteBatch instance. Used for chaining method calls.
Exceptions
Error - If the provided input is not valid Firestore data.