AMT-Cheif
/
drift
mirror of https://github.com/AMT-Cheif/drift.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Remove docs references to connect constructor

This commit is contained in:
Simon Binder 2023-08-31 10:57:54 +02:00
parent 303d738749
commit 043d41ee73
No known key found for this signature in database
GPG Key ID: 7891917E4147B8C0
2 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/pages/docs/Advanced Features/migrations.md
View File

@ -246,12 +246,14 @@ void main() {
In general, a test looks like this:
1. Use `verifier.startAt()` to obtain a [connection](https://drift.simonbinder.eu/api/drift/databaseconnection-class)
to a database with an initial schema.
This database contains all your tables, indices and triggers from that version, created by using `Migrator.createAll`.
2. Create your application database with that connection - you can forward the `DatabaseConnection` to the
`GeneratedDatabase.connect()` constructor on the parent class for this.
to a database with an initial schema.
This database contains all your tables, indices and triggers from that version, created by using `Migrator.createAll`.
2. Create your application database with that connection. For this, create a constructor in your database class that
accepts a `QueryExecutor` and forwards it to the super constructor in `GeneratedDatabase`.
Then, you can pass the result of calling `newConnection()` to that constructor to create a test instance of your
datbaase.
3. Call `verifier.migrateAndValidate(db, version)`. This will initiate a migration towards the target version (here, `2`).
Unlike the database created by `startAt`, this uses the migration logic you wrote for your database.
Unlike the database created by `startAt`, this uses the migration logic you wrote for your database.
`migrateAndValidate` will extract all `CREATE` statement from the `sqlite_schema` table and semantically compare them.
If it sees anything unexpected, it will throw a `SchemaMismatch` exception to fail your test.
@ -294,7 +296,7 @@ void main() {
final schema = await verifier.schemaAt(1);
// Add some data to the users table, which only has an id column at v1
final oldDb = v1.DatabaseAtV1.connect(schema.newConnection());
final oldDb = v1.DatabaseAtV1(schema.newConnection());
await oldDb.into(oldDb.users).insert(const v1.UsersCompanion(id: Value(1)));
await oldDb.close();
@ -304,7 +306,7 @@ void main() {
await db.close();
// Make sure the user is still here
final migratedDb = v2.DatabaseAtV2.connect(schema.newConnection());
final migratedDb = v2.DatabaseAtV2(schema.newConnection());
final user = await migratedDb.select(migratedDb.users).getSingle();
expect(user.id, 1);
expect(user.name, 'no name'); // default from the migration

4
drift_dev/lib/api/migrations.dart
View File

@ -194,7 +194,7 @@ class InitializedSchema {
///
/// // Insert some data from the view of the old database on an independent
/// // connection!
/// final oldDb = v1.DatabaseAtV1.connect(schema.newConnection());
/// final oldDb = v1.DatabaseAtV1(schema.newConnection());
/// await oldDb.into(oldDb.users).insert(v1.UsersCompanion(id: Value(1)));
/// await oldDb.close();
///
@ -204,7 +204,7 @@ class InitializedSchema {
/// await dbForMigration.close();
///
/// // Make sure the user is still here with a new database at v2
/// final checkDb = v2.DatabaseAtV2.connect(schema.newConnection());
/// final checkDb = v2.DatabaseAtV2(schema.newConnection());
/// final user = await checkDb.select(checkDb.users).getSingle();
/// expect(user.id, 1);
/// expect(user.name, 'default name from migration');