cloud_firestore_vm library


A CollectionReference can be used for adding documents, getting document references, and querying for documents (using the methods inherited from Query). [...]
A DocumentChange represents a change to the documents matching a query. It contains the document affected and a the type of change that occurred (added, modified, or removed). [...]
A DocumentReference refers to a document location in a Firestore database and can be used to write, read, or listen to the location. There may or may not exist a document at the referenced location. A DocumentReference can also be used to create a CollectionReference to a subcollection. [...]
A DocumentSnapshot contains data read from a document in your Firestore database. The data can be extracted with the data or get methods. [...]
A FieldPath refers to a field in a document. The path may consist of a single field name (referring to a top level field in the document), or a list of field names (referring to a nested field in the document).
Sentinel values that can be used when writing document fields with set or update.
Represents a Firestore Database and is the entry point for all Firestore operations [...]
Settings used to configure a FirebaseFirestore instance.
Immutable class representing a GeoPoint in Firestore
A Query which you can read or listen to. You can also construct refined Query objects by adding filters and ordering. [...]
A QueryDocumentSnapshot contains data read from a document in your Firestore database as part of a query. The document is guaranteed to exist and its data can be extracted using the data or get methods. [...]
A QuerySnapshot contains the results of a query. It can contain zero or more DocumentSnapshot objects. [...]
An options object that configures the behavior of set() calls. By providing one of the SetOptions objects returned by merge, mergeField and mergeFieldPaths, the set() calls in DocumentReference, WriteBatch and Transaction can be configured to perform granular merges instead of overwriting the target documents in their entirety.
Metadata about a snapshot, describing the state of the snapshot. [...]
A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are 'smeared' so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. [...]
A Transaction is passed to a Function to provide the methods to read and write data within the transaction context. [...]
A write batch, used to perform multiple writes as a single atomic unit. [...]


An enum for the direction of a sort.
Indicates whether metadata-only changes (i.e. only DocumentSnapshot.metadata or Query.metadata changed) should trigger snapshot events.
Configures the behavior of DocumentReference.get and Query.get. By providing a Source value, these methods can be configured to fetch results only from the server, only from the local cache, or attempt to fetch results from the server and fall back to the cache (which is the default).


BatchCallback(WriteBatch) Future<void>
The signature for providing code to be executed within a WriteBatch context.
OnConfigure(Database db) Future<void>
OnCreate(Database db, int version) Future<void>
OnOpen(Database db) Future<void>
OnVersionChange(Database db, int oldVersion, int newVersion) Future<void>
OpenDatabase(String path, {int version, OnConfigure onConfigure, OnCreate onCreate, OnVersionChange onUpgrade, OnVersionChange onDowngrade, OnOpen onOpen}) Future<Database>
TransactionCallback<T>(Transaction) Future<T>
The signature for providing code to be executed within a transaction context.

Exceptions / Errors