Drift (Moor) — що це, реактивна ORM і робота з базами даних

Що таке Drift?

Drift — це ORM для Dart та Flutter, раніше відомий як Moor. Був розроблений Саймоном Біндером у 2019 році і з того часу пройшов кілька мажорних версій. Drift компілює Dart-запити в SQL на етапі збірки за допомогою drift_dev та build_runner, що забезпечує повну типобезпеку та уникає синтаксичних помилок SQL під час виконання.

На відміну від Floor, Drift використовує власний DSL (мова предметної області) для побудови запитів — розробник пише на Dart, а генератор перекладає це в SQL. Це дозволяє IDE перевіряти синтаксис, автоматично доповнювати поля таблиць та рефакторувати модель даних без страху зламати запити.

За даними Drift (2024), бібліотека використовується в понад 8000 Flutter-проектах. Вона підтримує всі популярні платформи: Android через sqflite, iOS через sqflite, web через sqlite3 WASM, десктоп через нативний драйвер sqlite3.

Історія перейменування: Moor → Drift

Moor був перейменований на Drift у версії 2.0 (2022). Причиною був конфлікт назв з іншими проектами та бажання відійти від старого коду. API залишилась сумісною: для міграції достатьо замінити import з moor на drift та оновити залежності.

Ключові можливості

Drift надає: вбудовані Stream-запити з автоматичним оновленням при зміні даних, підтримку транзакцій з відкотом, користувацькі SQL-запити через rawQuery, патерн DAO для інкапсуляції логіки, кросплатформенні міграції та інтеграцію з Riverpod та BLoC через пакети drift_riverpod та drift_bloc.

Як працює Drift?

Drift використовує генерацію коду на етапі компіляції. Розробник описує таблиці через анотації @DataClass або Dart-класи, що розширюють Table. Генератор створює допоміжні класи: Companion (для полів, що можуть бути null під час вставки/оновлення), DriftDatabase (точка входу) та реалізації DAO.

Drift не виконує SQLite-запити безпосередньо. Натомість розробник пише на Dart: select(tasks).where(tasks.priority.greaterThan(3)).build(). Генератор перекладає це в SQL, а під час виконання Drift просто надсилає готовий SQL-запит до SQLite. Це поєднує зручність Dart-синтаксису з продуктивністю нативного SQL.

Архітектура запитів

Drift підтримує два режими запитів: DSL (рекомендований) та сирий SQL. DSL-запити писати безпечніше — компілятор перевіряє назви полів, типи та сумісність. Сирий SQL потрібен для складних запитів, не покритих DSL: віконні функції, рекурсивні CTE, специфічні розширення SQLite.

Drift DSL vs SQL: порівняння підходів

Drift пропонує два способи написання запитів: Dart DSL (нативний) та сирий SQL (для складних випадків). DSL краще підходить для 90% сценаріїв: він безпечніший, читабельніший та підтримує рефакторинг. Сирий SQL використовується лише коли DSL не покриває необхідної конструкції.

Коли використовувати DSL

Drift DSL — основний спосіб роботи. Він охоплює SELECT, INSERT, UPDATE, DELETE, WHERE, ORDER BY, LIMIT, JOIN та групування. Для всіх типових CRUD-запитів використовуйте DSL: він коротший, безпечніший та автоматично оновлює Stream при змінах.

Коли використовувати сирий SQL

Сирий SQL в Drift потрібен для: користувацьких функцій SQLite (FTS5, JSON1), складних підзапитів з EXISTS, INSERT OR REPLACE, масових UPDATE з CASE, а також для запитів, де продуктивність критична і DSL не генерує оптимальний план виконання. Сирий SQL можна писати в .sql-файлах з підтримкою типізації через drift_dev.

Приклади коду з Drift

Drift використовує класи, що розширюють Table, або анотацію @DataClass. Нижче наведено повний приклад моделі Task з запитами через DSL, сирий SQL та реактивним оновленням. Після запуску build_runner, всі згенеровані класи готові.

Визначення таблиці та бази даних

Клас Tasks розширює Table та визначає стовпці. Кожен стовпець — це вираз типу Column<T>. Параметри: withDefault() задає значення за замовчуванням, autoIncrement() задає автоматичне збільшення. База даних — це абстрактний клас, що розширює $DriftDatabase.

class Tasks extends Table {
    IntColumn get id => integer().autoIncrement();
    TextColumn get title => text().withDefault(const Constant(''))();
    BoolColumn get isCompleted => boolean().withDefault(const Constant(false))();
    IntColumn get priority => integer().withDefault(const Constant(0))();
}

@DriftDatabase(tables: [Tasks])
class AppDatabase extends $AppDatabase {
    AppDatabase(QueryExecutor e) : super(e);
}

CRUD-операції через DSL

Drift генерує методи into(tasks).insert(), select(tasks), update(tasks) та delete(tasks) для таблиць. Усі операції повертають Future — робота з SQLite асинхронна. Для відстеження змін використовуйте .watch() замість .get().

// Запис
await into(tasks).insert(TasksCompanion.insert(
    title: Value('Купити продукти'),
    priority: Value(3),
));

// Читання з фільтром
final highPriority = await (select(tasks)
    ..where((t) => t.priority.greaterThan(2))
    ..orderBy([(t) => OrderingTerm(expression: t.priority, mode: OrderingMode.desc)]))
    .get();

// Реактивне спостереження
select(tasks).watch().listen((tasksList) {
    // tasksList — List, обновляется при каждом изменении таблицы
    updateUi(tasksList);
});

Сирий SQL з типізованим результатом

Для складних запитів Drift дозволяє писати сирий SQL зі збереженням типізації. Метод customSelect бере рядок запиту та повертає типізований результат через генератор коду. Цей підхід поєднує гнучкість SQL з типобезпекою Drift.

final result = await customSelect(
    'SELECT title, COUNT(*) as cnt FROM tasks GROUP BY title',
    readsFrom: { tasks },
).get();

for (final row in result) {
    print('${row.readString("title")}: ${row.readInt("cnt")}');
}

Міграції та версіонування в Drift

Drift підтримує як автоматичні міграції (для простих змін), так і ручні (для складних трансформацій). Версія бази даних задається в конструкторі AppDatabase. При неспівпадінні версії Drift застосовує всі незакриті міграції послідовно.

Автоматичні міграції

Для додавання стовпця зі значенням за замовчуванням Drift може автоматично згенерувати міграцію через MigrationStrategy. Якщо зміна не порушує існуючі дані (додавання поля, що може бути null), можна використовувати beforeOpen з перевіркою версії та виконанням ALTER TABLE.

Ручні міграції

Для складних змін (перейменування таблиці, об'єднання даних, зміна типу стовпця) Drift потребує ручної SQL-міграції. Міграції задаються через параметр migrations в класі бази даних. Кожна міграція — це об'єкт з номерами from/to та SQL-запитами.

Drift та тестування

Drift підтримує запуск в тестовому режимі через NativeDatabase.memory(). База даних в пам'яті створюється з нуля перед кожним тестом та знищується після. Для мокування використовуйте пакет mocktail з імітованим QueryExecutor. Drift також надає DatabaseTestHelper для інтеграційних тестів з перевіркою міграцій та запитів.

Патерн DAO в Drift

Drift підтримує DAO (Об'єкт доступу до даних) через абстрактні класи з анотацією @DriftAccessor. DAO інкапсулює запити до однієї або кількох таблиць та може бути протестований окремо від бази даних. На відміну від прямих запитів через Database, DAO дозволяє повторно використовувати логіку запитів між різними частинами додатка та спрощує модульне тестування.

@DriftDatabase(tables: [Tasks])
class AppDatabase extends $AppDatabase {
    AppDatabase(QueryExecutor e) : super(e) {
        migrations.add(Migration(1, 2, (m) async {
            await m.addColumn(tasks, tasks.dueDate);
            await m.createIndex(tasks.idxPriority);
        }));
    }
}