firestore_odmType-safe Firestore for Flutter

Describe your documents once and get typed queries, updates, aggregates, transactions and streams. A misspelled field is a compile error, not a production bug. The maintained successor to cloud_firestore_odm.

Get started

Migrate from cloud_firestore_odm

GitHub

$ flutter pub add firestore_odm cloud_firestore firebase_core dev:firestore_odm_builder dev:build_runner

Typed queries

where(($) => $.age(isGreaterThan: 18) | $.tags(arrayContains: 'vip')), nested fields, ordering with record-typed cursors. A misspelled field is a compile error.

Typed updates

patch(($) => [$.likes.increment(1), $.tags.arrayUnion(['new'])]), plus patchAll and deleteAll over a query.

Aggregates, transactions, batches

Server-side count, sum and average as a typed record; transactions with reads before deferred writes; typed batches.

Current Firebase

Built for cloud_firestore 6 and firebase_core 4, analyzer 9 to 14, freezed 3. Stable releases.

Any model style

Plain Dart classes, freezed or json_serializable. DateTime is stored as a Timestamp; GeoPoint, DocumentReference and Blob fields are stored natively.

One-command migration

A codemod moves a cloud_firestore_odm project over and lists anything left to finish by hand. Your data does not change.

dart

final adults = await db.users
    .where(($) => $.age(isGreaterThanOrEqualTo: 18))
    .orderBy(($) => ($.age(descending: true), $.name()))
    .limit(20)
    .get(); // List<User>

await db.users('kim').patch(($) => [$.age.increment(1), $.lastLogin.serverTimestamp()]);

final stats = await db.users
    .aggregate(($) => (count: $.count(), averageAge: $.age.average()))
    .get(); // ({int count, double averageAge})