FirefuelBatch<T extends Serializable> class

Inheritance

• Object
• Batch<T>
• FirefuelBatch

Constructors

FirefuelBatch(FirefuelCollection<T> collection)

Properties

batch → WriteBatch

no setter, inherited

collection → FirefuelCollection<T>

final, inherited

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

totalTransactionsCommitted → int

The total number of transactions in the batch that have been committed

no setter, inherited

transactionLimit → int

The maximum transactionSize of transactions that can be committed at once

no setter, inherited

transactionSize → int

Each request adds 1 to the size of the batch.

no setter, inherited

Methods

commit() → Future<void>

Commits the current batch of transactions

override

create(T value) → Future<void>

Create a new document with an auto-generated DocumentId

override

createById({required T value, required DocumentId docId}) → Future<void>

Create a new document with the provided docId

override

delete(DocumentId docId) → Future<void>

Deletes the current document from the collection.

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

replace({required DocumentId docId, required T value}) → Future<void>

Replaces the document at docId with value.

override

replaceFields({required DocumentId docId, required T value, required List<String> fieldPaths}) → Future<void>

Replaces the fields of the document at docId with the matching fieldPaths from value

override

reset() → void

Creates a new batch without commiting the current transactions

override

toString() → String

A string representation of this object.

inherited

update({required DocumentId docId, required T value}) → Future<void>

Updates data on the document. Data will be merged with any existing document data.

override

updateOrCreate({required DocumentId docId, required T value}) → Future<void>

Updates data on the document if it exists. Data will be merged with any existing document data.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited