Skip to content

armgit / ente

Public Imported from GitHub
0

πŸ’š End-to-end encrypted cloud for everything.

Migrate Photos databases to sqlite_async

laurenspriema2eac5432cda
diff --git a/mobile/apps/photos/lib/db/collections_db.dart b/mobile/apps/photos/lib/db/collections_db.dart
index bddef84383..970dd97c6e 100644
--- a/mobile/apps/photos/lib/db/collections_db.dart
+++ b/mobile/apps/photos/lib/db/collections_db.dart
@@ -3,13 +3,14 @@ import 'dart:io';
import 'package:path/path.dart';
import 'package:path_provider/path_provider.dart';
+import 'package:photos/db/common/base.dart';
+import 'package:photos/db/common/conflict_algo.dart';
import "package:photos/gateways/collections/models/public_url.dart";
import "package:photos/models/api/collection/user.dart";
import 'package:photos/models/collection/collection.dart';
-import 'package:sqflite/sqflite.dart';
-import 'package:sqflite_migration/sqflite_migration.dart';
+import 'package:sqlite_async/sqlite_async.dart';
-class CollectionsDB {
+class CollectionsDB with SqlDbBase {
static const _databaseName = "ente.collections.db";
static const table = 'collections';
static const tempTable = 'temp_collections';
@@ -56,27 +57,24 @@ class CollectionsDB {
...addSharedAt(),
];
- final dbConfig = MigrationConfig(
- initializationScript: intitialScript,
- migrationScripts: migrationScripts,
- );
-
CollectionsDB._privateConstructor();
static final CollectionsDB instance = CollectionsDB._privateConstructor();
- static Future<Database>? _dbFuture;
+ static Future<SqliteDatabase>? _dbFuture;
- Future<Database> get database async {
+ Future<SqliteDatabase> get database async {
_dbFuture ??= _initDatabase();
return _dbFuture!;
}
- Future<Database> _initDatabase() async {
+ Future<SqliteDatabase> _initDatabase() async {
final Directory documentsDirectory =
await getApplicationDocumentsDirectory();
final String path = join(documentsDirectory.path, _databaseName);
- return await openDatabaseWithMigration(path, dbConfig);
+ final database = SqliteDatabase(path: path);
+ await migrate(database, [...intitialScript, ...migrationScripts]);
+ return database;
}
Future<void> clearTable() async {
@@ -214,7 +212,7 @@ class CollectionsDB {
batch.insert(
table,
_getRowForCollection(collection),
- conflictAlgorithm: ConflictAlgorithm.replace,
+ conflictAlgorithm: SqliteAsyncConflictAlgorithm.replace,
);
batchCounter++;
}
diff --git a/mobile/apps/photos/lib/db/common/base.dart b/mobile/apps/photos/lib/db/common/base.dart
index 3bbd0e2793..17824a2d7b 100644
--- a/mobile/apps/photos/lib/db/common/base.dart
+++ b/mobile/apps/photos/lib/db/common/base.dart
@@ -1,4 +1,6 @@
import "package:flutter/foundation.dart";
+import "package:photos/db/common/conflict_algo.dart";
+import "package:sqlite_async/sqlite3_common.dart";
import "package:sqlite_async/sqlite_async.dart";
mixin SqlDbBase {
@@ -16,7 +18,7 @@ mixin SqlDbBase {
List<String> migrationScripts,
) async {
final result = await database.execute('PRAGMA user_version');
- final currentVersion = result[0]['user_version'] as int;
+ final currentVersion = result.first['user_version'] as int;
final toVersion = migrationScripts.length;
if (currentVersion < toVersion) {
@@ -26,7 +28,8 @@ mixin SqlDbBase {
await database.writeTransaction((tx) async {
for (int i = currentVersion + 1; i <= toVersion; i++) {
try {
- await tx.execute(migrationScripts[i - 1]);
+ final script = migrationScripts[i - 1];
+ await tx.computeWithDatabase(_scriptExecutor(script));
} catch (e) {
debugPrint(
"$runtimeType Error running migration script index ${i - 1} $e",
@@ -36,6 +39,7 @@ mixin SqlDbBase {
}
await tx.execute('PRAGMA user_version = $toVersion');
});
+ await database.refreshSchema();
} else if (currentVersion > toVersion) {
throw AssertionError(
"currentVersion($currentVersion) cannot be greater than toVersion($toVersion)",
@@ -43,3 +47,148 @@ mixin SqlDbBase {
}
}
}
+
+Future<void> Function(CommonDatabase) _scriptExecutor(String script) {
+ return (database) async {
+ database.execute(script);
+ };
+}
+
+extension SqliteAsyncConvenience on SqliteDatabase {
+ Future<List<Map<String, dynamic>>> query(
+ String table, {
+ List<String>? columns,
+ String? where,
+ List<Object?>? whereArgs,
+ String? orderBy,
+ int? limit,
+ int? offset,
+ }) async {
+ final query = StringBuffer('SELECT ${columns?.join(', ') ?? '*'} ')
+ ..write('FROM $table');
+ final parameters = <Object?>[...?whereArgs];
+ if (where != null) {
+ query.write(' WHERE $where');
+ }
+ if (orderBy != null) {
+ query.write(' ORDER BY $orderBy');
+ }
+ if (limit != null) {
+ query.write(' LIMIT ?');
+ parameters.add(limit);
+ } else if (offset != null) {
+ query.write(' LIMIT -1');
+ }
+ if (offset != null) {
+ query.write(' OFFSET ?');
+ parameters.add(offset);
+ }
+ return _toMaps(await getAll(query.toString(), parameters));
+ }
+
+ Future<List<Map<String, dynamic>>> rawQuery(
+ String sql, [
+ List<Object?> parameters = const [],
+ ]) async {
+ return _toMaps(await getAll(sql, parameters));
+ }
+
+ Future<int> insert(
+ String table,
+ Map<String, Object?> values, {
+ SqliteAsyncConflictAlgorithm? conflictAlgorithm,
+ }) {
+ final statement = _insertStatement(table, values, conflictAlgorithm);
+ return writeTransaction((tx) async {
+ await tx.execute(statement.sql, statement.parameters);
+ final row = await tx.get('SELECT last_insert_rowid() AS id');
+ return row['id'] as int;
+ });
+ }
+
+ Future<int> update(
+ String table,
+ Map<String, Object?> values, {
+ String? where,
+ List<Object?>? whereArgs,
+ }) {
+ final assignments = values.keys.map((column) => '$column = ?').join(', ');
+ final sql = StringBuffer('UPDATE $table SET $assignments');
+ if (where != null) {
+ sql.write(' WHERE $where');
+ }
+ return _executeAndGetChangeCount(sql.toString(), [
+ ...values.values,
+ ...?whereArgs,
+ ]);
+ }
+
+ Future<int> delete(String table, {String? where, List<Object?>? whereArgs}) {
+ final sql = StringBuffer('DELETE FROM $table');
+ if (where != null) {
+ sql.write(' WHERE $where');
+ }
+ return _executeAndGetChangeCount(sql.toString(), [...?whereArgs]);
+ }
+
+ Future<int> rawUpdate(String sql, [List<Object?> parameters = const []]) {
+ return _executeAndGetChangeCount(sql, parameters);
+ }
+
+ SqliteAsyncBatch batch() => SqliteAsyncBatch(this);
+
+ Future<int> _executeAndGetChangeCount(String sql, List<Object?> parameters) {
+ return writeTransaction((tx) async {
+ await tx.execute(sql, parameters);
+ final row = await tx.get('SELECT changes() AS count');
+ return row['count'] as int;
+ });
+ }
+}
+
+class SqliteAsyncBatch {
+ SqliteAsyncBatch(this._database);
+
+ final SqliteDatabase _database;
+ final List<({String sql, List<Object?> parameters})> _statements = [];
+
+ void insert(
+ String table,
+ Map<String, Object?> values, {
+ SqliteAsyncConflictAlgorithm? conflictAlgorithm,
+ }) {
+ _statements.add(_insertStatement(table, values, conflictAlgorithm));
+ }
+
+ void rawDelete(String sql, [List<Object?> parameters = const []]) {
+ _statements.add((sql: sql, parameters: parameters));
+ }
+
+ Future<void> commit({bool noResult = false}) {
+ return _database.writeTransaction((tx) async {
+ for (final statement in _statements) {
+ await tx.execute(statement.sql, statement.parameters);
+ }
+ });
+ }
+}
+
+({String sql, List<Object?> parameters}) _insertStatement(
+ String table,
+ Map<String, Object?> values,
+ SqliteAsyncConflictAlgorithm? conflictAlgorithm,
+) {
+ final conflict = conflictAlgorithm == null
+ ? ''
+ : ' OR ${conflictAlgorithm.name.toUpperCase()}';
+ final columns = values.keys.join(', ');
+ final placeholders = List.filled(values.length, '?').join(', ');
+ return (
+ sql: 'INSERT$conflict INTO $table ($columns) VALUES ($placeholders)',
+ parameters: values.values.toList(growable: false),
+ );
+}
+
+List<Map<String, dynamic>> _toMaps(Iterable<Map<String, Object?>> rows) {
+ return rows.map(Map<String, dynamic>.from).toList(growable: false);
+}
diff --git a/mobile/apps/photos/lib/db/device_files_db.dart b/mobile/apps/photos/lib/db/device_files_db.dart
index 5c83da4973..fc5a86f238 100644
--- a/mobile/apps/photos/lib/db/device_files_db.dart
+++ b/mobile/apps/photos/lib/db/device_files_db.dart
@@ -2,6 +2,7 @@ import 'package:collection/collection.dart';
import 'package:flutter/foundation.dart';
import 'package:logging/logging.dart';
import 'package:photo_manager/photo_manager.dart';
+import 'package:photos/db/common/conflict_algo.dart';
import 'package:photos/db/files_db.dart';
import 'package:photos/models/device_collection.dart';
import 'package:photos/models/file/file.dart';
@@ -9,7 +10,6 @@ import 'package:photos/models/file_load_result.dart';
import 'package:photos/models/freeable_space_info.dart';
import 'package:photos/models/upload_strategy.dart';
import "package:photos/services/sync/import/model.dart";
-import 'package:sqflite/sqlite_api.dart';
import 'package:tuple/tuple.dart';
extension DeviceFiles on FilesDB {
@@ -19,7 +19,8 @@ extension DeviceFiles on FilesDB {
Future<void> insertPathIDToLocalIDMapping(
Map<String, Set<String>> mappingToAdd, {
- ConflictAlgorithm conflictAlgorithm = ConflictAlgorithm.ignore,
+ SqliteAsyncConflictAlgorithm conflictAlgorithm =
+ SqliteAsyncConflictAlgorithm.ignore,
}) async {
debugPrint("Inserting missing PathIDToLocalIDMapping");
final parameterSets = <List<Object?>>[];
@@ -484,7 +485,7 @@ extension DeviceFiles on FilesDB {
Future<void> _insertBatch(
List<List<Object?>> parameterSets,
- ConflictAlgorithm conflictAlgorithm,
+ SqliteAsyncConflictAlgorithm conflictAlgorithm,
) async {
final db = await sqliteAsyncDB;
await db.executeBatch('''
diff --git a/mobile/apps/photos/lib/db/entities_db.dart b/mobile/apps/photos/lib/db/entities_db.dart
index 0d097c9b03..5f6535b61b 100644
--- a/mobile/apps/photos/lib/db/entities_db.dart
+++ b/mobile/apps/photos/lib/db/entities_db.dart
@@ -1,13 +1,14 @@
import 'package:flutter/foundation.dart';
+import 'package:photos/db/common/conflict_algo.dart';
import 'package:photos/db/files_db.dart';
import "package:photos/gateways/entity/models/type.dart";
import "package:photos/models/local_entity_data.dart";
-import 'package:sqflite/sqlite_api.dart';
extension EntitiesDB on FilesDB {
Future<void> upsertEntities(
List<LocalEntityData> data, {
- ConflictAlgorithm conflictAlgorithm = ConflictAlgorithm.replace,
+ SqliteAsyncConflictAlgorithm conflictAlgorithm =
+ SqliteAsyncConflictAlgorithm.replace,
}) async {
debugPrint("entitiesDB: upsertEntities ${data.length} entities");
final db = await sqliteAsyncDB;
diff --git a/mobile/apps/photos/lib/db/file_updation_db.dart b/mobile/apps/photos/lib/db/file_updation_db.dart
index 6f2b2b5de7..21320d90da 100644
--- a/mobile/apps/photos/lib/db/file_updation_db.dart
+++ b/mobile/apps/photos/lib/db/file_updation_db.dart
@@ -4,10 +4,11 @@ import 'package:flutter/foundation.dart';
import 'package:logging/logging.dart';
import 'package:path/path.dart';
import 'package:path_provider/path_provider.dart';
-import 'package:sqflite/sqflite.dart';
-import 'package:sqflite_migration/sqflite_migration.dart';
+import 'package:photos/db/common/base.dart';
+import 'package:photos/db/common/conflict_algo.dart';
+import 'package:sqlite_async/sqlite_async.dart';
-class FileUpdationDB {
+class FileUpdationDB with SqlDbBase {
static const _databaseName = "ente.files_migration.db";
static final Logger _logger = Logger((FileUpdationDB).toString());
@@ -42,28 +43,25 @@ class FileUpdationDB {
static final initializationScript = [..._createTable()];
static final migrationScripts = [...addReasonColumn()];
- final dbConfig = MigrationConfig(
- initializationScript: initializationScript,
- migrationScripts: migrationScripts,
- );
-
FileUpdationDB._privateConstructor();
static final FileUpdationDB instance = FileUpdationDB._privateConstructor();
- static Future<Database>? _dbFuture;
+ static Future<SqliteDatabase>? _dbFuture;
- Future<Database> get database async {
+ Future<SqliteDatabase> get database async {
_dbFuture ??= _initDatabase();
return _dbFuture!;
}
- Future<Database> _initDatabase() async {
+ Future<SqliteDatabase> _initDatabase() async {
final Directory documentsDirectory =
await getApplicationDocumentsDirectory();
final String path = join(documentsDirectory.path, _databaseName);
debugPrint("DB path " + path);
- return await openDatabaseWithMigration(path, dbConfig);
+ final database = SqliteDatabase(path: path);
+ await migrate(database, [...initializationScript, ...migrationScripts]);
+ return database;
}
Future<void> clearTable() async {
@@ -85,7 +83,7 @@ class FileUpdationDB {
batch.insert(
tableName,
_getRowForReUploadTable(localID, reason),
- conflictAlgorithm: ConflictAlgorithm.replace,
+ conflictAlgorithm: SqliteAsyncConflictAlgorithm.replace,
);
batchCounter++;
}
@@ -105,19 +103,25 @@ class FileUpdationDB {
if (localIDs.isEmpty) {
return;
}
- final inParam = localIDs.map((id) => "'$id'").join(',');
final db = await instance.database;
- await db.rawQuery('''
+ await db.executeBatch(
+ '''
DELETE FROM $tableName
- WHERE $columnLocalID IN ($inParam) AND $columnReason = '$reason';
- ''');
+ WHERE $columnLocalID = ? AND $columnReason = ?;
+ ''',
+ [
+ for (final localID in localIDs) [localID, reason],
+ ],
+ );
}
Future<bool> isExisting(String localID, String reason) async {
final db = await instance.database;
- final String whereClause =
- '$columnLocalID = "$localID" AND $columnReason = "$reason"';
- final rows = await db.query(tableName, where: whereClause);
+ final rows = await db.query(
+ tableName,
+ where: '$columnLocalID = ? AND $columnReason = ?',
+ whereArgs: [localID, reason],
+ );
return rows.isNotEmpty;
}
@@ -126,8 +130,12 @@ class FileUpdationDB {
String reason,
) async {
final db = await instance.database;
- final String whereClause = '$columnReason = "$reason"';
- final rows = await db.query(tableName, limit: limit, where: whereClause);
+ final rows = await db.query(
+ tableName,
+ limit: limit,
+ where: '$columnReason = ?',
+ whereArgs: [reason],
+ );
final result = <String>[];
for (final row in rows) {
result.add(row[columnLocalID] as String);
@@ -139,12 +147,16 @@ class FileUpdationDB {
if (reasons.isEmpty) {
return;
}
- final inParam = reasons.map((reason) => "'$reason'").join(',');
final db = await instance.database;
- await db.rawQuery('''
+ await db.executeBatch(
+ '''
DELETE FROM $tableName
- WHERE $columnReason IN ($inParam);
- ''');
+ WHERE $columnReason = ?;
+ ''',
+ [
+ for (final reason in reasons) [reason],
+ ],
+ );
}
Map<String, dynamic> _getRowForReUploadTable(String localID, String reason) {
diff --git a/mobile/apps/photos/lib/db/ignored_files_db.dart b/mobile/apps/photos/lib/db/ignored_files_db.dart
index 774cca2cc9..4af0f40329 100644
--- a/mobile/apps/photos/lib/db/ignored_files_db.dart
+++ b/mobile/apps/photos/lib/db/ignored_files_db.dart
@@ -3,13 +3,14 @@ import 'dart:io';
import 'package:logging/logging.dart';
import 'package:path/path.dart';
import 'package:path_provider/path_provider.dart';
+import 'package:photos/db/common/base.dart';
+import 'package:photos/db/common/conflict_algo.dart';
import 'package:photos/models/ignored_file.dart';
-import 'package:sqflite/sqflite.dart';
+import 'package:sqlite_async/sqlite_async.dart';
// Prevent files deleted from Ente from being reuploaded without user action.
-class IgnoredFilesDB {
+class IgnoredFilesDB with SqlDbBase {
static const _databaseName = "ente.ignored_files.db";
- static const _databaseVersion = 1;
static final Logger _logger = Logger("IgnoredFilesDB");
static const tableName = 'ignored_files';
@@ -18,8 +19,8 @@ class IgnoredFilesDB {
static const columnDeviceFolder = 'device_folder';
static const columnReason = 'reason';
- Future _onCreate(Database db, int version) async {
- await db.execute('''
+ static const _migrationScripts = [
+ '''
CREATE TABLE $tableName (
$columnLocalID TEXT NOT NULL,
$columnTitle TEXT NOT NULL,
@@ -29,29 +30,27 @@ class IgnoredFilesDB {
);
CREATE INDEX IF NOT EXISTS local_id_index ON $tableName($columnLocalID);
CREATE INDEX IF NOT EXISTS device_folder_index ON $tableName($columnDeviceFolder);
- ''');
- }
+ ''',
+ ];
IgnoredFilesDB._privateConstructor();
static final IgnoredFilesDB instance = IgnoredFilesDB._privateConstructor();
- static Future<Database>? _dbFuture;
+ static Future<SqliteDatabase>? _dbFuture;
- Future<Database> get database async {
+ Future<SqliteDatabase> get database async {
_dbFuture ??= _initDatabase();
return _dbFuture!;
}
- Future<Database> _initDatabase() async {
+ Future<SqliteDatabase> _initDatabase() async {
final Directory documentsDirectory =
await getApplicationDocumentsDirectory();
final String path = join(documentsDirectory.path, _databaseName);
- return await openDatabase(
- path,
- version: _databaseVersion,
- onCreate: _onCreate,
- );
+ final database = SqliteDatabase(path: path);
+ await migrate(database, _migrationScripts);
+ return database;
}
Future<void> clearTable() async {
@@ -73,7 +72,7 @@ class IgnoredFilesDB {
batch.insert(
tableName,
_getRowForIgnoredFile(file),
- conflictAlgorithm: ConflictAlgorithm.replace,
+ conflictAlgorithm: SqliteAsyncConflictAlgorithm.replace,
);
batchCounter++;
}
@@ -114,12 +113,13 @@ class IgnoredFilesDB {
// See IgnoredFileService#_getIgnoreID method for more detail
if (Platform.isAndroid) {
batch.rawDelete(
- "DELETE from $tableName WHERE $columnDeviceFolder = '${file.deviceFolder}' AND $columnTitle = '${file.title}' ",
+ "DELETE FROM $tableName WHERE $columnDeviceFolder = ? AND $columnTitle = ?",
+ [file.deviceFolder, file.title],
);
} else {
- batch.rawDelete(
- "DELETE from $tableName WHERE $columnLocalID = '${file.localID}' ",
- );
+ batch.rawDelete("DELETE FROM $tableName WHERE $columnLocalID = ?", [
+ file.localID,
+ ]);
}
batchCounter++;
}
diff --git a/mobile/apps/photos/lib/db/memories_db.dart b/mobile/apps/photos/lib/db/memories_db.dart
index 8dbbf14272..85d9b4289f 100644
--- a/mobile/apps/photos/lib/db/memories_db.dart
+++ b/mobile/apps/photos/lib/db/memories_db.dart
@@ -3,12 +3,13 @@ import 'dart:io';
import 'package:path/path.dart';
import 'package:path_provider/path_provider.dart';
+import 'package:photos/db/common/base.dart';
+import 'package:photos/db/common/conflict_algo.dart';
import 'package:photos/models/memories/memory.dart';
-import 'package:sqflite/sqflite.dart';
+import 'package:sqlite_async/sqlite_async.dart';
-class MemoriesDB {
+class MemoriesDB with SqlDbBase {
static const _databaseName = "ente.memories.db";
- static const _databaseVersion = 1;
static const table = 'memories';
@@ -24,30 +25,26 @@ class MemoriesDB {
dbName: "ente.memories.offline.db",
);
- Future<Database>? _dbFuture;
- Future<Database> get database async {
+ Future<SqliteDatabase>? _dbFuture;
+ Future<SqliteDatabase> get database async {
_dbFuture ??= _initDatabase();
return _dbFuture!;
}
- Future<Database> _initDatabase() async {
+ Future<SqliteDatabase> _initDatabase() async {
final Directory documentsDirectory =
await getApplicationDocumentsDirectory();
final String path = join(documentsDirectory.path, _dbName);
- return await openDatabase(
- path,
- version: _databaseVersion,
- onCreate: _onCreate,
- );
- }
-
- Future _onCreate(Database db, int version) async {
- await db.execute('''
+ final database = SqliteDatabase(path: path);
+ await migrate(database, [
+ '''
CREATE TABLE $table (
$columnFileID INTEGER PRIMARY KEY NOT NULL,
$columnSeenTime TEXT NOT NULL
)
- ''');
+ ''',
+ ]);
+ return database;
}
Future<void> clearTable() async {
@@ -73,7 +70,7 @@ class MemoriesDB {
return await db.insert(
table,
_getRowForSeenMemory(memory, timestamp, seenTimeKey: seenTimeKey),
- conflictAlgorithm: ConflictAlgorithm.replace,
+ conflictAlgorithm: SqliteAsyncConflictAlgorithm.replace,
);
}
diff --git a/mobile/apps/photos/lib/db/memory_shares_db.dart b/mobile/apps/photos/lib/db/memory_shares_db.dart
index 4268d36015..b7a4d9707a 100644
--- a/mobile/apps/photos/lib/db/memory_shares_db.dart
+++ b/mobile/apps/photos/lib/db/memory_shares_db.dart
@@ -2,12 +2,13 @@ import 'dart:io';
import 'package:path/path.dart';
import 'package:path_provider/path_provider.dart';
+import 'package:photos/db/common/base.dart';
+import 'package:photos/db/common/conflict_algo.dart';
import 'package:photos/models/api/memory_share/memory_share.dart';
-import 'package:sqflite/sqflite.dart';
+import 'package:sqlite_async/sqlite_async.dart';
-class MemorySharesDB {
+class MemorySharesDB with SqlDbBase {
static const _databaseName = "ente.memory_shares.db";
- static const _databaseVersion = 1;
static const _table = 'memory_shares';
@@ -29,26 +30,20 @@ class MemorySharesDB {
MemorySharesDB._();
static final MemorySharesDB instance = MemorySharesDB._();
- static Future<Database>? _dbFuture;
+ static Future<SqliteDatabase>? _dbFuture;
- Future<Database> get database async {
+ Future<SqliteDatabase> get database async {
_dbFuture ??= _initDatabase();
return _dbFuture!;
}
- Future<Database> _initDatabase() async {
+ Future<SqliteDatabase> _initDatabase() async {
final Directory documentsDirectory =
await getApplicationDocumentsDirectory();
final String path = join(documentsDirectory.path, _databaseName);
- return await openDatabase(
- path,
- version: _databaseVersion,
- onCreate: _onCreate,
- );
- }
-
- Future<void> _onCreate(Database db, int version) async {
- await db.execute('''
+ final database = SqliteDatabase(path: path);
+ await migrate(database, [
+ '''
CREATE TABLE $_table (
$_columnID INTEGER PRIMARY KEY NOT NULL,
$_columnType TEXT NOT NULL,
@@ -65,7 +60,9 @@ class MemorySharesDB {
$_columnPreviewUploadedFileID INTEGER,
$_columnFileCount INTEGER
)
- ''');
+ ''',
+ ]);
+ return database;
}
Future<void> upsert(MemoryShare share) async {
@@ -73,7 +70,7 @@ class MemorySharesDB {
await db.insert(
_table,
_toRow(share),
- conflictAlgorithm: ConflictAlgorithm.replace,
+ conflictAlgorithm: SqliteAsyncConflictAlgorithm.replace,
);
}
diff --git a/mobile/apps/photos/lib/db/social_db.dart b/mobile/apps/photos/lib/db/social_db.dart
index 94dc8d12a8..11379e7879 100644
--- a/mobile/apps/photos/lib/db/social_db.dart
+++ b/mobile/apps/photos/lib/db/social_db.dart
@@ -5,45 +5,24 @@ import 'package:flutter/foundation.dart';
import 'package:logging/logging.dart';
import 'package:path/path.dart';
import 'package:path_provider/path_provider.dart';
+import 'package:photos/db/common/base.dart';
+import 'package:photos/db/common/conflict_algo.dart';
import 'package:photos/models/social/anon_profile.dart';
import 'package:photos/models/social/comment.dart';
import 'package:photos/models/social/reaction.dart';
-import 'package:sqflite/sqflite.dart';
+import 'package:sqlite_async/sqlite_async.dart';
-class SocialDB {
+class SocialDB with SqlDbBase {
static final Logger _logger = Logger("SocialDB");
static const _databaseName = "ente.social.db";
- static const _databaseVersion = 1;
static const _commentsTable = 'comments';
static const _reactionsTable = 'reactions';
static const _syncTimeTable = 'sync_time';
static const _anonProfilesTable = 'anon_profiles';
- SocialDB._();
- static final SocialDB instance = SocialDB._();
-
- static Future<Database>? _dbFuture;
-
- Future<Database> get database async {
- _dbFuture ??= _initDatabase();
- return _dbFuture!;
- }
-
- Future<Database> _initDatabase() async {
- final Directory documentsDirectory =
- await getApplicationDocumentsDirectory();
- final String path = join(documentsDirectory.path, _databaseName);
- _logger.info("DB path: $path");
- return await openDatabase(
- path,
- version: _databaseVersion,
- onCreate: _onCreate,
- );
- }
-
- Future<void> _onCreate(Database db, int version) async {
- await db.execute('''
+ static const _migrationScripts = [
+ '''
CREATE TABLE $_commentsTable (
id TEXT PRIMARY KEY NOT NULL,
collection_id INTEGER NOT NULL,
@@ -56,10 +35,7 @@ class SocialDB {
anon_user_id TEXT,
created_at INTEGER NOT NULL,
updated_at INTEGER NOT NULL
- )
- ''');
-
- await db.execute('''
+ );
CREATE TABLE $_reactionsTable (
id TEXT PRIMARY KEY NOT NULL,
collection_id INTEGER NOT NULL,
@@ -71,19 +47,13 @@ class SocialDB {
anon_user_id TEXT,
created_at INTEGER NOT NULL,
updated_at INTEGER NOT NULL
- )
- ''');
-
- await db.execute('''
+ );
CREATE TABLE $_syncTimeTable (
collection_id INTEGER PRIMARY KEY NOT NULL,
comments_sync_time INTEGER NOT NULL DEFAULT 0,
reactions_sync_time INTEGER NOT NULL DEFAULT 0,
anon_profiles_sync_time INTEGER NOT NULL DEFAULT 0
- )
- ''');
-
- await db.execute('''
+ );
CREATE TABLE $_anonProfilesTable (
anon_user_id TEXT NOT NULL,
collection_id INTEGER NOT NULL,
@@ -91,15 +61,32 @@ class SocialDB {
created_at INTEGER NOT NULL,
updated_at INTEGER NOT NULL,
PRIMARY KEY (anon_user_id, collection_id)
- )
- ''');
+ );
+ CREATE INDEX idx_comments_file_collection
+ ON $_commentsTable(file_id, collection_id);
+ CREATE INDEX idx_reactions_file_collection
+ ON $_reactionsTable(file_id, collection_id);
+ ''',
+ ];
- await db.execute(
- 'CREATE INDEX idx_comments_file_collection ON $_commentsTable(file_id, collection_id)',
- );
- await db.execute(
- 'CREATE INDEX idx_reactions_file_collection ON $_reactionsTable(file_id, collection_id)',
- );
+ SocialDB._();
+ static final SocialDB instance = SocialDB._();
+
+ static Future<SqliteDatabase>? _dbFuture;
+
+ Future<SqliteDatabase> get database async {
+ _dbFuture ??= _initDatabase();
+ return _dbFuture!;
+ }
+
+ Future<SqliteDatabase> _initDatabase() async {
+ final Directory documentsDirectory =
+ await getApplicationDocumentsDirectory();
+ final String path = join(documentsDirectory.path, _databaseName);
+ _logger.info("DB path: $path");
+ final database = SqliteDatabase(path: path);
+ await migrate(database, _migrationScripts);
+ return database;
}
Future<void> addComment(Comment comment) async {
@@ -107,7 +94,7 @@ class SocialDB {
await db.insert(
_commentsTable,
_commentToRow(comment),
- conflictAlgorithm: ConflictAlgorithm.replace,
+ conflictAlgorithm: SqliteAsyncConflictAlgorithm.replace,
);
}
@@ -192,7 +179,7 @@ class SocialDB {
'AND is_deleted = 0',
[fileID, ...collectionIDs],
);
- return Sqflite.firstIntValue(result) ?? 0;
+ return result.first['count'] as int;
}
Future<int> getCommentCountForFileInCollection(
@@ -205,7 +192,7 @@ class SocialDB {
'WHERE file_id = ? AND collection_id = ? AND is_deleted = 0',
[fileID, collectionID],
);
- return Sqflite.firstIntValue(result) ?? 0;
+ return result.first['count'] as int;
}
Future<List<Comment>> getCommentsForCollection(int collectionID) async {
@@ -385,7 +372,7 @@ class SocialDB {
await db.insert(_syncTimeTable, {
'collection_id': collectionID,
'comments_sync_time': syncTime,
- }, conflictAlgorithm: ConflictAlgorithm.replace);
+ }, conflictAlgorithm: SqliteAsyncConflictAlgorithm.replace);
}
Future<void> setReactionsSyncTime(int collectionID, int syncTime) async {
@@ -393,7 +380,7 @@ class SocialDB {
await db.insert(_syncTimeTable, {
'collection_id': collectionID,
'reactions_sync_time': syncTime,
- }, conflictAlgorithm: ConflictAlgorithm.replace);
+ }, conflictAlgorithm: SqliteAsyncConflictAlgorithm.replace);
}
Future<void> clearSyncTime(int collectionID) async {
@@ -446,7 +433,7 @@ class SocialDB {
batch.insert(
_commentsTable,
_commentToRow(comment),
- conflictAlgorithm: ConflictAlgorithm.replace,
+ conflictAlgorithm: SqliteAsyncConflictAlgorithm.replace,
);
}
await batch.commit(noResult: true);
@@ -476,7 +463,7 @@ class SocialDB {
batch.insert(
_reactionsTable,
_reactionToRow(reaction),
- conflictAlgorithm: ConflictAlgorithm.replace,
+ conflictAlgorithm: SqliteAsyncConflictAlgorithm.replace,
);
}
await batch.commit(noResult: true);
@@ -490,7 +477,7 @@ class SocialDB {
batch.insert(
_anonProfilesTable,
_anonProfileToRow(profile),
- conflictAlgorithm: ConflictAlgorithm.replace,
+ conflictAlgorithm: SqliteAsyncConflictAlgorithm.replace,
);
}
await batch.commit(noResult: true);
diff --git a/mobile/apps/photos/lib/db/trash_db.dart b/mobile/apps/photos/lib/db/trash_db.dart
index 78cbe53563..73dc31837b 100644
--- a/mobile/apps/photos/lib/db/trash_db.dart
+++ b/mobile/apps/photos/lib/db/trash_db.dart
@@ -4,14 +4,15 @@ import 'dart:io';
import 'package:logging/logging.dart';
import 'package:path/path.dart';
import 'package:path_provider/path_provider.dart';
+import 'package:photos/db/common/base.dart';
+import 'package:photos/db/common/conflict_algo.dart';
import 'package:photos/models/file/trash_file.dart';
import 'package:photos/models/file_load_result.dart';
-import 'package:sqflite/sqflite.dart';
+import 'package:sqlite_async/sqlite_async.dart';
// Store only fields needed to query trash. Restore fetches the full file.
-class TrashDB {
+class TrashDB with SqlDbBase {
static const _databaseName = "ente.trash.db";
- static const _databaseVersion = 2;
static final Logger _logger = Logger("TrashDB");
static const tableName = 'trash';
@@ -38,8 +39,8 @@ class TrashDB {
static const columnPubMMdEncodedJson = 'pub_mmd_encoded_json';
static const columnPubMMdVersion = 'pub_mmd_ver';
- Future _onCreate(Database db, int version) async {
- await db.execute('''
+ static const _migrationScripts = [
+ '''
CREATE TABLE $tableName (
$columnUploadedFileID INTEGER PRIMARY KEY NOT NULL,
$columnCollectionID INTEGER NOT NULL,
@@ -51,7 +52,6 @@ class TrashDB {
$columnFileDecryptionHeader TEXT,
$columnThumbnailDecryptionHeader TEXT,
$columnUpdationTime INTEGER,
- $columnFileSize INTEGER DEFAULT NULL,
$columnLocalID TEXT,
$columnCreationTime INTEGER NOT NULL,
$columnFileMetadata TEXT DEFAULT '{}',
@@ -63,39 +63,29 @@ class TrashDB {
CREATE INDEX IF NOT EXISTS creation_time_index ON $tableName($columnCreationTime);
CREATE INDEX IF NOT EXISTS delete_by_time_index ON $tableName($columnTrashDeleteBy);
CREATE INDEX IF NOT EXISTS updated_at_time_index ON $tableName($columnTrashUpdatedAt);
- ''');
- }
-
- Future<void> _onUpgrade(Database db, int oldVersion, int newVersion) async {
- if (oldVersion < 2) {
- await db.execute(
- 'ALTER TABLE $tableName ADD COLUMN $columnFileSize INTEGER DEFAULT NULL',
- );
- }
- }
+ ''',
+ 'ALTER TABLE $tableName ADD COLUMN $columnFileSize INTEGER DEFAULT NULL',
+ ];
TrashDB._privateConstructor();
static final TrashDB instance = TrashDB._privateConstructor();
- static Future<Database>? _dbFuture;
+ static Future<SqliteDatabase>? _dbFuture;
- Future<Database> get database async {
+ Future<SqliteDatabase> get database async {
_dbFuture ??= _initDatabase();
return _dbFuture!;
}
- Future<Database> _initDatabase() async {
+ Future<SqliteDatabase> _initDatabase() async {
final Directory documentsDirectory =
await getApplicationDocumentsDirectory();
final String path = join(documentsDirectory.path, _databaseName);
_logger.info("DB path " + path);
- return await openDatabase(
- path,
- version: _databaseVersion,
- onCreate: _onCreate,
- onUpgrade: _onUpgrade,
- );
+ final database = SqliteDatabase(path: path);
+ await migrate(database, _migrationScripts);
+ return database;
}
Future<void> clearTable() async {
@@ -105,10 +95,8 @@ class TrashDB {
Future<int> count() async {
final db = await instance.database;
- final count = Sqflite.firstIntValue(
- await db.rawQuery('SELECT COUNT(*) FROM $tableName'),
- );
- return count ?? 0;
+ final row = await db.get('SELECT COUNT(*) AS count FROM $tableName');
+ return row['count'] as int;
}
Future<void> insertMultiple(List<EnteTrashFile> trashFiles) async {
@@ -125,7 +113,7 @@ class TrashDB {
batch.insert(
tableName,
_getRowForTrash(trash),
- conflictAlgorithm: ConflictAlgorithm.replace,
+ conflictAlgorithm: SqliteAsyncConflictAlgorithm.replace,
);
batchCounter++;
}
@@ -145,11 +133,24 @@ class TrashDB {
}
Future<int> delete(List<int> uploadedFileIDs) async {
+ if (uploadedFileIDs.isEmpty) {
+ return 0;
+ }
final db = await instance.database;
- return db.delete(
- tableName,
- where: '$columnUploadedFileID IN (${uploadedFileIDs.join(', ')})',
- );
+ var deletedRows = 0;
+ for (var start = 0; start < uploadedFileIDs.length; start += 400) {
+ final end = start + 400 < uploadedFileIDs.length
+ ? start + 400
+ : uploadedFileIDs.length;
+ final ids = uploadedFileIDs.sublist(start, end);
+ deletedRows += await db.delete(
+ tableName,
+ where:
+ '$columnUploadedFileID IN (${List.filled(ids.length, '?').join(', ')})',
+ whereArgs: ids,
+ );
+ }
+ return deletedRows;
}
Future<int> update(EnteTrashFile file) async {
diff --git a/mobile/apps/photos/lib/db/upload_locks_db.dart b/mobile/apps/photos/lib/db/upload_locks_db.dart
index 187c2158e9..aad67ddff0 100644
--- a/mobile/apps/photos/lib/db/upload_locks_db.dart
+++ b/mobile/apps/photos/lib/db/upload_locks_db.dart
@@ -5,11 +5,13 @@ import 'dart:io';
import 'package:path/path.dart';
import 'package:path_provider/path_provider.dart';
import "package:photos/core/errors.dart";
+import 'package:photos/db/common/base.dart';
+import 'package:photos/db/common/conflict_algo.dart';
import "package:photos/module/upload/model/multipart.dart";
-import 'package:sqflite/sqflite.dart';
-import "package:sqflite_migration/sqflite_migration.dart";
+import 'package:sqlite_async/sqlite3_common.dart';
+import 'package:sqlite_async/sqlite_async.dart';
-class UploadLocksDB {
+class UploadLocksDB with SqlDbBase {
static const _databaseName = "ente.upload_locks.db";
static const _uploadLocksTable = (
@@ -83,26 +85,23 @@ class UploadLocksDB {
];
}
- final dbConfig = MigrationConfig(
- initializationScript: initializationScript,
- migrationScripts: migrationScripts,
- );
-
UploadLocksDB._privateConstructor();
static final UploadLocksDB instance = UploadLocksDB._privateConstructor();
- static Future<Database>? _dbFuture;
- Future<Database> get database async {
+ static Future<SqliteDatabase>? _dbFuture;
+ Future<SqliteDatabase> get database async {
_dbFuture ??= _initDatabase();
return _dbFuture!;
}
- Future<Database> _initDatabase() async {
+ Future<SqliteDatabase> _initDatabase() async {
final Directory documentsDirectory =
await getApplicationDocumentsDirectory();
final String path = join(documentsDirectory.path, _databaseName);
- return await openDatabaseWithMigration(path, dbConfig);
+ final database = SqliteDatabase(path: path);
+ await migrate(database, [...initializationScript, ...migrationScripts]);
+ return database;
}
static List<String> _createUploadLocksTable() {
@@ -184,13 +183,13 @@ class UploadLocksDB {
await db.insert(
_uploadLocksTable.table,
row,
- conflictAlgorithm: ConflictAlgorithm.fail,
+ conflictAlgorithm: SqliteAsyncConflictAlgorithm.fail,
);
return true;
- } on DatabaseException catch (e) {
- final lockIDColumn =
- '${_uploadLocksTable.table}.${_uploadLocksTable.columnID}';
- if (e.isUniqueConstraintError(lockIDColumn)) {
+ } on SqliteException catch (e) {
+ if (e.extendedResultCode ==
+ SqlExtendedError.SQLITE_CONSTRAINT_PRIMARYKEY ||
+ e.extendedResultCode == SqlExtendedError.SQLITE_CONSTRAINT_UNIQUE) {
return false;
}
rethrow;
@@ -398,12 +397,16 @@ class UploadLocksDB {
) async {
final db = await database;
- await db.insert(_streamUploadErrorTable.table, {
- _streamUploadErrorTable.columnUploadedFileID: uploadedFileID,
- _streamUploadErrorTable.columnErrorMessage: errorMessage,
- _streamUploadErrorTable.columnLastAttemptedAt:
- DateTime.now().millisecondsSinceEpoch,
- }, conflictAlgorithm: ConflictAlgorithm.replace);
+ await db.insert(
+ _streamUploadErrorTable.table,
+ {
+ _streamUploadErrorTable.columnUploadedFileID: uploadedFileID,
+ _streamUploadErrorTable.columnErrorMessage: errorMessage,
+ _streamUploadErrorTable.columnLastAttemptedAt:
+ DateTime.now().millisecondsSinceEpoch,
+ },
+ conflictAlgorithm: SqliteAsyncConflictAlgorithm.replace,
+ );
}
Future<void> updateStreamStatus(
@@ -592,10 +595,14 @@ class UploadLocksDB {
String queueType, // 'create' or 'recreate'
) async {
final db = await database;
- await db.insert(_streamQueueTable.table, {
- _streamQueueTable.columnUploadedFileID: uploadedFileID,
- _streamQueueTable.columnQueueType: queueType,
- }, conflictAlgorithm: ConflictAlgorithm.replace);
+ await db.insert(
+ _streamQueueTable.table,
+ {
+ _streamQueueTable.columnUploadedFileID: uploadedFileID,
+ _streamQueueTable.columnQueueType: queueType,
+ },
+ conflictAlgorithm: SqliteAsyncConflictAlgorithm.replace,
+ );
}
Future<void> removeFromStreamQueue(int uploadedFileID) async {
diff --git a/mobile/apps/photos/pubspec.yaml b/mobile/apps/photos/pubspec.yaml
index f2758331e8..3c7dc29e4f 100644
--- a/mobile/apps/photos/pubspec.yaml
+++ b/mobile/apps/photos/pubspec.yaml
@@ -187,8 +187,6 @@ dependencies:
sentry_flutter: 9.6.0
share_plus: 12.0.0
shared_preferences: 2.5.3
- sqflite: 2.4.2
- sqflite_migration: 0.3.0
sqlite3_flutter_libs: 0.5.41
sqlite_async: 0.11.7
styled_text: 8.1.0
@@ -221,7 +219,6 @@ dev_dependencies:
json_serializable: 6.11.2
mockito: 5.5.1
path_provider_platform_interface: 2.1.3
- sqflite_common_ffi: 2.3.7+1
test: 1.26.3
# ------------------------------
diff --git a/mobile/apps/photos/test/db/social_db_test.dart b/mobile/apps/photos/test/db/social_db_test.dart
index 56c1347b59..3845bb21b9 100644
--- a/mobile/apps/photos/test/db/social_db_test.dart
+++ b/mobile/apps/photos/test/db/social_db_test.dart
@@ -5,7 +5,6 @@ import "package:path_provider_platform_interface/path_provider_platform_interfac
import "package:photos/db/social_db.dart";
import "package:photos/models/social/comment.dart";
import "package:photos/models/social/reaction.dart";
-import "package:sqflite_common_ffi/sqflite_ffi.dart";
void main() {
TestWidgetsFlutterBinding.ensureInitialized();
@@ -14,8 +13,6 @@ void main() {
late PathProviderPlatform previousPathProvider;
setUpAll(() async {
- sqfliteFfiInit();
- databaseFactory = databaseFactoryFfi;
previousPathProvider = PathProviderPlatform.instance;
tempDir = await Directory.systemTemp.createTemp("social_db_test_");
PathProviderPlatform.instance = _FakePathProvider(tempDir.path);
diff --git a/mobile/pubspec.lock b/mobile/pubspec.lock
index 109b8cae9a..f4abca9b6f 100644
--- a/mobile/pubspec.lock
+++ b/mobile/pubspec.lock
@@ -2579,14 +2579,6 @@ packages:
url: "https://pub.dev"
source: hosted
version: "2.4.2"
- sqflite_migration:
- dependency: transitive
- description:
- name: sqflite_migration
- sha256: "8134886ceaa738c0b7a014cf6115817d6abb0598a7435b18815c25c0d5cffdd0"
- url: "https://pub.dev"
- source: hosted
- version: "0.3.0"
sqflite_platform_interface:
dependency: transitive
description: