Class WriteBatch

A Firestore WriteBatch that can be used to atomically commit multiple write operations at once.

WriteBatch

Package

@google-cloud/firestore

Constructors

(constructor)(firestore)

constructor(firestore: Firestore);

Constructs a new instance of the WriteBatch class

Parameter
NameDescription
firestore Firestore

Properties

_opCount

get _opCount(): number;

The number of writes in this batch.

Methods

commit()

commit(): Promise<WriteResult[]>;

Atomically commits all pending operations to the database and verifies all preconditions. Fails the entire write if any precondition is not met.

Returns
TypeDescription
Promise<WriteResult[]>

{Promise.<Array.

Example

let writeBatch = firestore.batch();
let documentRef = firestore.doc('col/doc');

writeBatch.set(documentRef, {foo: 'bar'});

writeBatch.commit().then(() => {
  console.log('Successfully executed batch.');
});

create(documentRef, data)

create<T>(documentRef: firestore.DocumentReference<T>, data: firestore.WithFieldValue<T>): WriteBatch;

Create a document with the provided object values. This will fail the batch if a document exists at its location.

Parameters
NameDescription
documentRef FirebaseFirestore.DocumentReference<T>

A reference to the document to be created.

data FirebaseFirestore.WithFieldValue<T>

The object to serialize as the document.

Returns
TypeDescription
WriteBatch

{WriteBatch} This WriteBatch instance. Used for chaining method calls.

Type Parameter
NameDescription
T
Example

let writeBatch = firestore.batch();
let documentRef = firestore.collection('col').doc();

writeBatch.create(documentRef, {foo: 'bar'});

writeBatch.commit().then(() => {
  console.log('Successfully executed batch.');
});

delete(documentRef, precondition)

delete<T>(documentRef: firestore.DocumentReference<T>, precondition?: firestore.Precondition): WriteBatch;

Deletes a document from the database.

Parameters
NameDescription
documentRef FirebaseFirestore.DocumentReference<T>

A reference to the document to be deleted.

precondition firestore.Precondition

A precondition to enforce for this delete.

Returns
TypeDescription
WriteBatch

{WriteBatch} This WriteBatch instance. Used for chaining method calls.

Type Parameter
NameDescription
T
Example

let writeBatch = firestore.batch();
let documentRef = firestore.doc('col/doc');

writeBatch.delete(documentRef);

writeBatch.commit().then(() => {
  console.log('Successfully executed batch.');
});

set(documentRef, data, options)

set<T>(documentRef: firestore.DocumentReference<T>, data: firestore.PartialWithFieldValue<T>, options: firestore.SetOptions): WriteBatch;
Parameters
NameDescription
documentRef FirebaseFirestore.DocumentReference<T>
data FirebaseFirestore.PartialWithFieldValue<T>
options firestore.SetOptions
Returns
TypeDescription
WriteBatch
Type Parameter
NameDescription
T

set(documentRef, data)

set<T>(documentRef: firestore.DocumentReference<T>, data: firestore.WithFieldValue<T>): WriteBatch;
Parameters
NameDescription
documentRef FirebaseFirestore.DocumentReference<T>
data FirebaseFirestore.WithFieldValue<T>
Returns
TypeDescription
WriteBatch
Type Parameter
NameDescription
T

update(documentRef, dataOrField, preconditionOrValues)

update<T = firestore.DocumentData>(documentRef: firestore.DocumentReference<T>, dataOrField: firestore.UpdateData<T> | string | firestore.FieldPath, ...preconditionOrValues: Array<{
        lastUpdateTime?: firestore.Timestamp;
    } | unknown | string | firestore.FieldPath>): WriteBatch;

Update fields of the document referred to by the provided [DocumentReference]DocumentReference. If the document doesn't yet exist, the update fails and the entire batch will be rejected.

The update() method accepts either an object with field paths encoded as keys and field values encoded as values, or a variable number of arguments that alternate between field paths and field values. Nested fields can be updated by providing dot-separated field path strings or by providing FieldPath objects.

A Precondition restricting this update can be specified as the last argument.

Parameters
NameDescription
documentRef FirebaseFirestore.DocumentReference<T>

A reference to the document to be updated.

dataOrField FirebaseFirestore.UpdateData<T> | string | FirebaseFirestore.FieldPath

An object containing the fields and values with which to update the document or the path of the first field to update.

preconditionOrValues Array<{ lastUpdateTime?: FirebaseFirestore.Timestamp; } | unknown | string | FirebaseFirestore.FieldPath>

An alternating list of field paths and values to update or a Precondition to restrict this update.

Returns
TypeDescription
WriteBatch

{WriteBatch} This WriteBatch instance. Used for chaining method calls.

Type Parameter
NameDescription
T
Example

let writeBatch = firestore.batch();
let documentRef = firestore.doc('col/doc');

writeBatch.update(documentRef, {foo: 'bar'});

writeBatch.commit().then(() => {
  console.log('Successfully executed batch.');
});