Author: Petrus Nguyễn Thái Học
- Reactive stream wrapper around
sqflitefor Flutter inspired by sqlbrite - Streaming sqflite
- RxDart reactive stream sqflite for Flutter
- A lightweight wrapper around sqflite which introduces reactive stream semantics to SQL operations.
- Depend on it: In your flutter project, add the dependency to your
pubspec.yaml
dependencies:
...
sqlbrite: <latest_version>- Install it: You can install packages from the command line with Flutter:
$ flutter packages get- Import it: Now in your Dart code, you can use:
import 'package:sqlbrite/sqlbrite.dart';final Database db = await openDb();
final briteDb = BriteDatabase(db);
final briteDb = BriteDatabase(db, logger: null); // disable logging.- The
BriteDatabase.createQuerymethod is similar toDatabase.query. Listen to the returnedStream<Query>which will immediately notify with aQueryto run. - These queries will run once to get the current data, then again whenever the given table is modified though the
BriteDatabase.
class Entity {
factory Entity.fromJson(Map<String, dynamic> map) { ... }
factory Entity.empty() { ... }
Map<String, dynamic> toJson() { ... }
}// Emits a single row, emit error if the row doesn't exist or more than 1 row in result set.
final Stream<Entity> singleQuery$ = briteDb.createQuery(
'table',
where: 'id = ?',
whereArgs: [id],
limit: 1,
).mapToOne((row) => Entity.fromJson(row));// Emits a single row, or the given default value if the row doesn't exist, or emit error if more than 1 row in result set
final Stream<Entity> singleOrDefaultQuery$ = briteDb.createQuery(
'table',
where: 'id = ?',
whereArgs: [id],
limit: 1,
).mapToOneOrDefault(
(row) => Entity.fromJson(row),
defaultValue: Entity.empty()
);// Emits a list of rows.
final Stream<List<Entity>> listQuery$ = briteDb.createQuery(
'table',
where: 'name LIKE ?',
whereArgs: [queryName],
).mapToList((row) => Entity.fromJson(row));// will trigger query stream again
briteDb.insert(
'table',
Entity(...).toJson()
);
// will trigger query stream again
briteDb.update(
'table',
Entity(...).toJson(),
where: 'id = ?',
whereArgs: [id],
);
// will trigger query stream again
briteDb.update(
'table',
where: 'id = ?',
whereArgs: [id],
);
- You can use RxDart operators to control the frequency of notifications to subscribers.
- The full power of RxDart's operators are available for combining, filtering, and triggering any number of queries and data changes.
briteDb
.createQuery(
'table',
where: 'name LIKE ?',
whereArgs: [queryName],
)
.debounceTime(const Duration(milliseconds: 500))
.where(filterQuery) // query is lazy, this lets you not even execute it if you don't need to
.mapToList((row) => Entity.fromJson(row))
.listen(updateUI);SQL Brite's only responsibility is to be a mechanism for coordinating and composing the notification of updates to tables such that you can update queries as soon as data changes.
This library is not an ORM. It is not a type-safe query mechanism. It's not going to perform database migrations for you.
MIT License
Copyright (c) 2019 - 2022 Petrus Nguyễn Thái Học
![renovate[bot] avatar](https://avatars.githubusercontent.com/in/2740?v=4 "renovate[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent