BulkWriter extension type

A Firestore BulkWriter than can be used to perform a large number of writes in parallel. Writes to the same document will be executed sequentially.

@class

on

• JSObject

Implemented types

• JSObject

Available extensions

• FirebaseJsInteropJSObjectExtension
• JSObjectUnsafeUtilExtension

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

close() → JSPromise<JSAny?>

Commits all enqueued writes and marks the BulkWriter instance as closed.

create(DocumentReference documentRef, JSObject data) → JSPromise<WriteResult>

Create a document with the provided data. This single operation will fail if a document exists at its location.

delete(DocumentReference documentRef, [Precondition precondition]) → JSPromise<WriteResult>

Delete a document from the database.

flush() → JSPromise<JSAny?>

Commits all writes that have been enqueued up to this point in parallel.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

onWriteError(JSFunction shouldRetryCallback) → void

Attaches an error handler listener that is run every time a BulkWriter operation fails.

onWriteResult(JSFunction callback) → void

Attaches a listener that is run every time a BulkWriter operation successfully completes.

set(DocumentReference documentRef, JSObject data, [SetOptions options]) → JSPromise<WriteResult>

Write to the document referred to by the provided DocumentReference{@link DocumentReference}. If the document does not exist yet, it will be created. If you pass SetOptions{@link SetOptions}., the provided data can be merged into the existing document.

toString() → String

A string representation of this object.

inherited

update(DocumentReference documentRef, JSObject data, [Precondition precondition]) → JSPromise<WriteResult>

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

updateFieldPath(DocumentReference documentRef, JSAny field, JSObject value, [JSArray<JSAny> precondition]) → JSPromise<WriteResult>

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

Operators

operator ==(Object other) → bool

The equality operator.

inherited