Files
MrbWebLibre/apps/weblibre/lib/features/user/data/database/database.dart
T

132 lines
4.4 KiB
Dart

/*
* Copyright (c) 2024-2026 Fabian Freund.
*
* This file is part of WebLibre
* (see https://weblibre.eu).
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
import 'package:drift/drift.dart';
import 'package:drift/internal/versioned_schema.dart';
import 'package:drift_dev/api/migrations_native.dart';
import 'package:flutter/foundation.dart';
import 'package:weblibre/features/user/data/database/daos/cache.dart';
import 'package:weblibre/features/user/data/database/daos/onboarding.dart';
import 'package:weblibre/features/user/data/database/daos/proxy_profile.dart';
import 'package:weblibre/features/user/data/database/daos/quick_switcher_button_config.dart';
import 'package:weblibre/features/user/data/database/daos/search_tokens.dart';
import 'package:weblibre/features/user/data/database/daos/setting.dart';
import 'package:weblibre/features/user/data/database/daos/toolbar_button_config.dart';
import 'package:weblibre/features/user/data/database/database.drift.dart';
import 'package:weblibre/features/user/data/database/database.steps.dart';
@DriftDatabase(
include: {'definitions.drift'},
daos: [
SettingDao,
CacheDao,
OnboardingDao,
ToolbarButtonConfigDao,
QuickSwitcherButtonConfigDao,
SearchTokensDao,
ProxyProfileDao,
],
)
class UserDatabase extends $UserDatabase {
@override
final int schemaVersion = 9;
@override
MigrationStrategy get migration => MigrationStrategy(
beforeOpen: (details) async {
if (kDebugMode) {
// This check pulls in a fair amount of code that's not needed
// anywhere else, so we recommend only doing it in debug builds.
await validateDatabaseSchema();
}
await customStatement('PRAGMA foreign_keys = ON;');
await onAfterOpen?.call(this);
},
onUpgrade: (m, from, to) async {
// Following the advice from https://drift.simonbinder.eu/Migrations/api/#general-tips
await customStatement('PRAGMA foreign_keys = OFF');
await transaction(
() => VersionedSchema.runMigrationSteps(
migrator: m,
from: from,
to: to,
steps: _upgrade,
),
);
if (kDebugMode) {
final wrongForeignKeys = await customSelect(
'PRAGMA foreign_key_check',
).get();
assert(
wrongForeignKeys.isEmpty,
'${wrongForeignKeys.map((e) => e.data)}',
);
}
await customStatement('PRAGMA foreign_keys = ON');
},
);
UserDatabase(super.e, {this.onAfterOpen});
final Future<void> Function(UserDatabase db)? onAfterOpen;
static final _upgrade = migrationSteps(
from1To2: (m, schema) async {
await m.createTable(schema.riverpod);
},
from2To3: (m, schema) async {
await m.createTable(schema.toolbarButtonConfigs);
await m.createIndex(schema.idxToolbarOrderKey);
},
from3To4: (m, schema) async {
await m.createTable(schema.searchTokens);
await m.createIndex(schema.idxSearchTokensInsertedAt);
},
from4To5: (m, schema) async {
await m.addColumn(schema.searchTokens, schema.searchTokens.reservedAt);
await m.createIndex(schema.idxSearchTokensReservedAt);
},
from5To6: (m, schema) async {
await m.createTable(schema.proxyProfile);
await m.createIndex(schema.idxProxyProfileUpdatedAt);
await m.createTable(schema.proxyRoutingSetting);
},
from6To7: (m, schema) async {
await m.addColumn(
schema.proxyProfile,
schema.proxyProfile.dnsOverrideJson,
);
},
from7To8: (m, schema) async {
await m.database.customStatement(
'DROP TABLE IF EXISTS proxy_routing_setting',
);
},
from8To9: (m, schema) async {
await m.createTable(schema.quickSwitcherButtonConfigs);
await m.createIndex(schema.idxQuickSwitcherOrderKey);
},
);
}