To start using the Cloud Firestore package within your project, import it at the top of your project files:
Before using Firestore, you must first have ensured you have initialized FlutterFire.
By default, this allows you to interact with Firestore using the default Firebase App used whilst installing FlutterFire on your
platform. If however you'd like to use Firestore with a secondary Firebase App, use the
Firestore stores data within "documents", which are contained within "collections". Documents can also contain
nested collections. For example, our users would each have their own "document" stored inside the "Users" collection.
collection method allows us to reference a collection within our code.
In the below example, we can reference the collection
users, and create a new user document when a button is pressed:
Cloud Firestore gives you the ability to read the value of a collection or a document. This can be a one-time read, or provided by realtime updates when the data within a query changes.
To learn more about reading data whilst offline, view the Access Data Offline documentation.
FlutterFire provides support for dealing with realtime changes to collections and documents. A new event is provided on the initial request, and any subsequent changes to collection/document whenever a change occurs (modification, deleted or added).
Once returned, you can subscribe to updates via the
listen() method. The below example uses a
which helps automatically manage the streams state and disposal of the stream when it's no longer used within your app:
By default, listeners do not update if there is a change that only affects the metadata. If you want to receive events
when the document or query metadata changes, you can pass
includeMetadataChanges to the
QuerySnapshot is returned from a collection query, and allows you to inspect the collection, such as how many documents
exist within it, gives access to the documents within the collection, see any changes since the last query and more.
DocumentSnapshot is returned from a query, or by accessing the
document directly. Even if no document exists in the database, a snapshot will always be returned.
To determine whether the document exists, use the
If the document exists, you can read the data of it by calling the
method, which returns a
Map<String, dynamic>, or
null if it does not exist:
DocumentSnapshot also provides the ability to access
deeply nested data without manually iterating the returned
Map via the
method. The method accepts a dot-separated path or a
If no data exists at the nested path, a
Cloud Firestore offers advanced capabilities for querying collections. Queries work with both one-time reads or subscribing to changes.
To filter documents within a collection, the
where method can be chained
onto a collection reference. Filtering supports equality checks and "in" queries. For example, for filter
users where their age is greater than 20:
Firestore also supports array queries. For example, to filter users who speak English (en) or Italian (it), use
To learn more about all of the querying capabilities Cloud Firestore has to offer, view the Firebase documentation.
To limit the number of documents returned from a query, use the
limit method on a collection reference:
You can also limit to the last documents within the collection query by using
To order the documents by a specific value, use the
To start and/or end a query at a specific point within a collection, you can pass a value to the
endBefore methods. You must specify an order to use cursor queries, for example:
You can further specify a
DocumentSnapshot instead of a specific value,
by passing it to the
endBeforeDocument methods. For example:
Cloud Firestore does not support the following types of queries:
- Queries with range filters on different fields, as described in the previous section.
- Logical OR queries. In this case, you should create a separate query for each OR condition and merge the query results in your app.
- Queries with a != clause. In this case, you should split the query into a greater-than query and a less-than query.
For example, the query clause
where("age", isNotEqualTo: 30)is not supported, however you can get the same result set by combining two queries, one with the clause
where("age", isLessThan: 30)and one with the clause
where("age", isGreaterThan: 30)
The Firebase Documentation provides some great examples on the best practices to structuring your data. It is recommended that you read the guide before building your database.
For more information on what is possible when writing data to Firestore, please refer to this documentation
By default, Firestore references manipulate a
Map<String, dynamic> object. The downside is that we lose type safety.
One solution is to use
withConverter, which will modify methods like
Query.where to be type-safe.
A common usage of
withConverter is when combined with a serializable class, such as:
We can then use
withConverter to manipulate a collection of movies like so:
Finally, we can use our new
moviesRef variable to perform read and write operations:
set with an id that already exists on the collection will replace all the document data. You can also specify
SetOptions(merge: true)) on the query, and this will merge the existing document with the data passed into the
Sometimes you may wish to update a document, rather than replacing all of the data. The
method above replaces any existing data on a given
If you'd like to update a document instead, use the
The method also provides support for updating deeply nested values via dot-notation:
Cloud Firestore supports storing and manipulating values on your database, such as Timestamps, GeoPoints, Blobs and array management.
GeoPoint values, provide the latitude
and longitude to the GeoPoint class:
To store a Blob such as an image, provide a
Uint8List. The below example shows how to get an image from your
directory and nest it in the
info object in Firestore.
Transactions are a way to ensure that a write operation only occurs using the latest data available on the server. Transactions never partially apply writes, and writes execute at the end of a successful transaction.
Transactions are useful when you want to update a field based on its current value, or the value of another field. If you want to write multiple documents without using the documents current state, a batch write should be used.
When using transactions, note that:
- Read operations must come before write operations
- Transactions will fail when the client is offline, they cannot use cached data
An example of where a transaction could be used would be in an application where a user can subscribe to a channel. When a user presses the subscribe button, a "subscribers" field in a document increments. Without using Transactions, we would first need to read the existing value, and then increment that value using two separate operations.
On a high traffic application, the value on the server could have already changed by the time the write operation sets a new value, causing the number to be inconsistent.
Transactions remove this issue by atomically updating the value of the server. If the value changes whilst the transaction is executing, it will retry, ensuring the value on the server is used, rather than the client value.
To execute a transaction, call the
In the above example, if the document changes at any point during the transaction, it will retry up-to five times.
You should not directly modify application state inside of the transaction, as the handler may execute multiple times. You should instead return a value at the end of the handler, updating application state once the transaction has completed.
If an exception is thrown within the handler, the entire transaction will be aborted.
First, create a new batch instance via the
batch method, then perform
the operations on the batch, and then commit it once ready. The below example shows how to delete
all documents in a collection in a single operation:
It is important that you understand how to write rules in your Firebase console to ensure that your data is secure. Please follow the Firebase Firestore documentation on security.
Firestore provides out of the box support for offline capabilities. When reading and writing data, Firestore uses a local database which automatically synchronizes with the server. Cloud Firestore functionality continues when users are offline, and automatically handles data migration when they regain connectivity.
This functionality is enabled by default, however it can be disabled if needed. The
settings must be set before any Firestore interaction is performed:
If you want to clear any persisted data, you can call the
Calls to update settings or clearing persistence must be carried out before any other usage of Firestore. If called afterwards, they will take effect on the next Firestore claim (e.g. restarting the application).
When persistence is enabled, Firestore caches every document for offline access. After exceeding the cache size, Firestore will attempt to remove older, unused data. You can configure different cache sizes, or disable the removal process:
It is possible to disable network access for your Firestore client. While network access is disabled, all Firestore requests retrieve results from the cache. Any write operations are queued until network access is re-enabled.
To re-enabled network access, call the
If you are using the local Firestore emulators, then it is possible to
connect to this using the
useFirestoreEmulator method. Ensure you pass the correct port on which the Firebase emulator is running on.
Ensure you have enabled network connections to the emulators in your apps following the emulator usage instructions in the general FlutterFire installation notes for each operating system.
If you have loaded a bundle with a named query, you may retrieve the
query snapshot by calling the