Start using new drift features since 2.5.0 #1248
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| // dart format width=80 | ||
| import 'package:drift/internal/versioned_schema.dart' as i0; | ||
| import 'package:drift/drift.dart' as i1; | ||
| import 'package:drift/drift.dart'; // ignore_for_file: type=lint,unused_import | ||
|
|
||
| // GENERATED BY drift_dev, DO NOT MODIFY. | ||
| final class Schema2 extends i0.VersionedSchema { | ||
| Schema2({required super.database}) : super(version: 2); | ||
| @override | ||
| late final List<i1.DatabaseSchemaEntity> entities = [ | ||
| accounts, | ||
| ]; | ||
| late final Shape0 accounts = Shape0( | ||
| source: i0.VersionedTable( | ||
| entityName: 'accounts', | ||
| withoutRowId: false, | ||
| isStrict: false, | ||
| tableConstraints: [ | ||
| 'UNIQUE(realm_url, user_id)', | ||
| 'UNIQUE(realm_url, email)', | ||
| ], | ||
| columns: [ | ||
| _column_0, | ||
| _column_1, | ||
| _column_2, | ||
| _column_3, | ||
| _column_4, | ||
| _column_5, | ||
| _column_6, | ||
| _column_7, | ||
| _column_8, | ||
| ], | ||
| attachedDatabase: database, | ||
| ), | ||
| alias: null); | ||
| } | ||
|
|
||
| class Shape0 extends i0.VersionedTable { | ||
| Shape0({required super.source, required super.alias}) : super.aliased(); | ||
| i1.GeneratedColumn<int> get id => | ||
| columnsByName['id']! as i1.GeneratedColumn<int>; | ||
| i1.GeneratedColumn<String> get realmUrl => | ||
| columnsByName['realm_url']! as i1.GeneratedColumn<String>; | ||
| i1.GeneratedColumn<int> get userId => | ||
| columnsByName['user_id']! as i1.GeneratedColumn<int>; | ||
| i1.GeneratedColumn<String> get email => | ||
| columnsByName['email']! as i1.GeneratedColumn<String>; | ||
| i1.GeneratedColumn<String> get apiKey => | ||
| columnsByName['api_key']! as i1.GeneratedColumn<String>; | ||
| i1.GeneratedColumn<String> get zulipVersion => | ||
| columnsByName['zulip_version']! as i1.GeneratedColumn<String>; | ||
| i1.GeneratedColumn<String> get zulipMergeBase => | ||
| columnsByName['zulip_merge_base']! as i1.GeneratedColumn<String>; | ||
| i1.GeneratedColumn<int> get zulipFeatureLevel => | ||
| columnsByName['zulip_feature_level']! as i1.GeneratedColumn<int>; | ||
| i1.GeneratedColumn<String> get ackedPushToken => | ||
| columnsByName['acked_push_token']! as i1.GeneratedColumn<String>; | ||
| } | ||
|
|
||
| i1.GeneratedColumn<int> _column_0(String aliasedName) => | ||
| i1.GeneratedColumn<int>('id', aliasedName, false, | ||
| hasAutoIncrement: true, | ||
| type: i1.DriftSqlType.int, | ||
| defaultConstraints: | ||
| i1.GeneratedColumn.constraintIsAlways('PRIMARY KEY AUTOINCREMENT')); | ||
| i1.GeneratedColumn<String> _column_1(String aliasedName) => | ||
| i1.GeneratedColumn<String>('realm_url', aliasedName, false, | ||
| type: i1.DriftSqlType.string); | ||
| i1.GeneratedColumn<int> _column_2(String aliasedName) => | ||
| i1.GeneratedColumn<int>('user_id', aliasedName, false, | ||
| type: i1.DriftSqlType.int); | ||
| i1.GeneratedColumn<String> _column_3(String aliasedName) => | ||
| i1.GeneratedColumn<String>('email', aliasedName, false, | ||
| type: i1.DriftSqlType.string); | ||
| i1.GeneratedColumn<String> _column_4(String aliasedName) => | ||
| i1.GeneratedColumn<String>('api_key', aliasedName, false, | ||
| type: i1.DriftSqlType.string); | ||
| i1.GeneratedColumn<String> _column_5(String aliasedName) => | ||
| i1.GeneratedColumn<String>('zulip_version', aliasedName, false, | ||
| type: i1.DriftSqlType.string); | ||
| i1.GeneratedColumn<String> _column_6(String aliasedName) => | ||
| i1.GeneratedColumn<String>('zulip_merge_base', aliasedName, true, | ||
| type: i1.DriftSqlType.string); | ||
| i1.GeneratedColumn<int> _column_7(String aliasedName) => | ||
| i1.GeneratedColumn<int>('zulip_feature_level', aliasedName, false, | ||
| type: i1.DriftSqlType.int); | ||
| i1.GeneratedColumn<String> _column_8(String aliasedName) => | ||
| i1.GeneratedColumn<String>('acked_push_token', aliasedName, true, | ||
| type: i1.DriftSqlType.string); | ||
| i0.MigrationStepWithVersion migrationSteps({ | ||
| required Future<void> Function(i1.Migrator m, Schema2 schema) from1To2, | ||
| }) { | ||
| return (currentVersion, database) async { | ||
| switch (currentVersion) { | ||
| case 1: | ||
| final schema = Schema2(database: database); | ||
| final migrator = i1.Migrator(database, schema); | ||
| await from1To2(migrator, schema); | ||
| return 2; | ||
| default: | ||
| throw ArgumentError.value('Unknown migration from $currentVersion'); | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| i1.OnUpgrade stepByStep({ | ||
| required Future<void> Function(i1.Migrator m, Schema2 schema) from1To2, | ||
| }) => | ||
| i0.VersionedSchema.stepByStepHelper( | ||
| step: migrationSteps( | ||
| from1To2: from1To2, | ||
| )); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -98,37 +98,62 @@ void main() { | |
| verifier = SchemaVerifier(GeneratedHelper()); | ||
| }); | ||
|
|
||
| test('downgrading', () async { | ||
| final connection = await verifier.startAt(2); | ||
| final db = AppDatabase(connection); | ||
| await verifier.migrateAndValidate(db, 1); | ||
| await db.close(); | ||
| }, skip: true); // TODO(#1172): unskip this | ||
|
|
||
| group('migrate without data', () { | ||
| // These simple tests verify all possible schema updates with a simple (no | ||
| // data) migration. This is a quick way to ensure that written database | ||
| // migrations properly alter the schema. | ||
| const versions = GeneratedHelper.versions; | ||
| for (final (i, fromVersion) in versions.indexed) { | ||
| group('from $fromVersion', () { | ||
| for (final toVersion in versions.skip(i + 1)) { | ||
| test('to $toVersion', () async { | ||
| final schema = await verifier.schemaAt(fromVersion); | ||
| final db = AppDatabase(schema.newConnection()); | ||
| await verifier.migrateAndValidate(db, toVersion); | ||
| await db.close(); | ||
| }); | ||
| } | ||
| }); | ||
| } | ||
| }); | ||
|
|
||
| // Testing this can be useful for migrations that change existing columns | ||
| // (e.g. by alterating their type or constraints). Migrations that only add | ||
| // tables or columns typically don't need these advanced tests. For more | ||
| // information, see https://drift.simonbinder.eu/migrations/tests/#verifying-data-integrity | ||
| group('migrate with data', () { | ||
| test('upgrade to v2', () async { | ||
| late final v1.AccountsData oldAccountData; | ||
| await verifier.testWithDataIntegrity( | ||
| oldVersion: 1, createOld: v1.DatabaseAtV1.new, | ||
| newVersion: 2, createNew: v2.DatabaseAtV2.new, | ||
| openTestedDatabase: AppDatabase.new, | ||
| createItems: (batch, oldDb) async { | ||
| await oldDb.into(oldDb.accounts).insert(v1.AccountsCompanion.insert( | ||
| realmUrl: 'https://chat.example/', | ||
| userId: 1, | ||
| email: '[email protected]', | ||
| apiKey: '1234', | ||
| zulipVersion: '6.0', | ||
| zulipMergeBase: const Value('6.0'), | ||
| zulipFeatureLevel: 42, | ||
| )); | ||
| oldAccountData = await oldDb.select(oldDb.accounts).watchSingle().first; | ||
| }, | ||
| validateItems: (newDb) async { | ||
| final account = await newDb.select(newDb.accounts).getSingle(); | ||
| check(account.toJson()).deepEquals({ | ||
| ...oldAccountData.toJson(), | ||
| 'ackedPushToken': null, | ||
| }); | ||
| }); | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a specific command we can put here, or perhaps refer the reader to some documentation, even if it's just
dart run build_runner --help? (Thedart runseems helpful to a contributor arriving here for the first time.)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't include the command for this as there are different ways to generate them, and some are more efficient the the others. We should point to the relevant piece of documentation ("Generated files" in
README.md), or move this section to the README.