f9a163532b
|
||
|---|---|---|
| .. | ||
| android | ||
| drift_schemas | ||
| ios | ||
| lib | ||
| linux | ||
| macos | ||
| test | ||
| tool | ||
| web | ||
| windows | ||
| .gitignore | ||
| .metadata | ||
| README.md | ||
| analysis_options.yaml | ||
| build.yaml | ||
| devtools_options.yaml | ||
| pubspec.yaml | ||
README.md
app
A cross-platform todo app using drift for local persistence.
Supported platforms
This app runs on
- Android
- iOS
- macOS
- Linux
- Windows
- Web
When running the app, either with flutter run or by running the outputs of
flutter build, native sqlite3 dependencies should be set up automatically.
When running the app in a regular Dart VM, for instance through flutter test,
you need to ensure that sqlite3 is available yourself. See the documentation
for more details on this.
To run or build this app on the web, first run build_runner build to compile
the web worker used to access databases.
Development
As this app uses drift, it depends on code-generation.
Use dart run build_runner build to automatically build the generated
code.
Testing
Drift databases don't depend on platform-channels or Flutter-specific features
by default. This means that they can easily be used in unit tests.
One such test is in test/database_test.dart
Migration
After changing the structure of your database schema, for instance by adding new tables or altering columns, you need to write a migration to ensure that existing users of your app can convert their database to the latest version.
Drift contains builtin APIs for common migrations. Also, it includes builtin tools to verify that migrations are doing what they're supposed to do.
To write such tests, run the following command after making schema changes and incrementing your schema version. It will export the current schema of the database as a JSON file. You should check those generated files into source control.
dart run drift_dev schema dump lib/database/database.dart drift_schemas/
Then, run the following command to automatically generate test utilities which you can use to write unit tests for schema migrations:
dart run drift_dev schema generate drift_schemas/ test/generated_migrations/
To make migrations easier, this command updates the lib/database/schema_versions.dart
file containing snapshots of older database schema:
dart run drift_dev schema steps drift_schemas/ lib/database/schema_versions.dart
An example for a schema test is in test/migration_test.dart.