4. データベース

drift でテーブルを定義する

この章のゴール

1

テーブルを定義

ユーザーと測定セッション

2

DB 本体を作る

AppDatabase と移行の設定

3

動作を確かめる

メモリ上の DB でテスト

テーブルの設計

erDiagram
  direction LR
  users ||--o{ sessions : has
  users {
    text id PK
    text name
    datetime createdAt
  }
  sessions {
    text id PK
    text userId FK
    real durationSec
    int sampleCount
    real peakGyro1
    real peakGyro2
    real peakAcc1
    real peakAcc2
    datetime recordedAt
  }

テーブル定義

lib/infrastructure/database/tables.dart
import 'package:drift/drift.dart';

// 利用者
class Users extends Table {
  TextColumn get id => text()(); // UUID
  TextColumn get name => text()();
  DateTimeColumn get createdAt => dateTime()();

  @override
  Set<Column> get primaryKey => {id};
}

// 1回の測定(セッション)の結果。利用者を削除すると一緒に消える
// センサ1・2それぞれの最大角速度[dps]と最大加速度[g]を保存する
class Sessions extends Table {
  TextColumn get id => text()();
  TextColumn get userId =>
      text().references(Users, #id, onDelete: KeyAction.cascade)();
  RealColumn get durationSec => real()(); // 測定時間[秒]
  IntColumn get sampleCount => integer()(); // 受け取ったデータ数
  RealColumn get peakGyro1 => real()(); // センサ1の最大角速度[dps]
  RealColumn get peakGyro2 => real()(); // センサ2の最大角速度[dps]
  RealColumn get peakAcc1 => real()(); // センサ1の最大加速度[g]
  RealColumn get peakAcc2 => real()(); // センサ2の最大加速度[g]
  DateTimeColumn get recordedAt => dateTime()();

  @override
  Set<Column> get primaryKey => {id};
}
  • クラス名は複数形(Sessions)、自動生成されるデータクラスは単数形(Session)
  • ユーザーを削除すると、その人のセッションも一緒に消える(onDelete: cascade)

データベース本体

lib/infrastructure/database/app_database.dart
import 'package:drift/drift.dart';
import 'package:drift_flutter/drift_flutter.dart';
import 'package:path_provider/path_provider.dart';
import 'package:motion_app/infrastructure/database/tables.dart';

part 'app_database.g.dart';

@DriftDatabase(tables: [Users, Sessions])
class AppDatabase extends _$AppDatabase {
  // テストではメモリDBを渡せるようにしておく
  AppDatabase([QueryExecutor? executor]) : super(executor ?? _open());

  @override
  int get schemaVersion => 1;

  @override
  MigrationStrategy get migration => MigrationStrategy(
        onCreate: (m) => m.createAll(),
        beforeOpen: (details) async {
          await customStatement('PRAGMA foreign_keys = ON');
        },
      );

  static QueryExecutor _open() => driftDatabase(
        name: 'motion_note',
        native: const DriftNativeOptions(
          databaseDirectory: getApplicationSupportDirectory,
        ),
      );
}

Provider に登録する

lib/provider/providers.dart
import 'package:riverpod_annotation/riverpod_annotation.dart';
import 'package:motion_app/infrastructure/database/app_database.dart';

part 'providers.g.dart';

@Riverpod(keepAlive: true)
AppDatabase appDatabase(Ref ref) {
  final db = AppDatabase();
  ref.onDispose(db.close);
  return db;
}
  • keepAlive: true → アプリ起動中はずっと同じ DB を使う
  • DB ファイルは 最初にクエリを実行したとき に自動で作られる

動作を確かめる

test/database_smoke_test.dart
import 'package:drift/native.dart';
import 'package:flutter_test/flutter_test.dart';
import 'package:motion_app/infrastructure/database/app_database.dart';

void main() {
  test('ユーザーを1件保存して読み出せる', () async {
    final db = AppDatabase(NativeDatabase.memory());
    await db.into(db.users).insert(UsersCompanion.insert(
          id: 'u1',
          name: 'たろう',
          createdAt: DateTime.now(),
        ));
    final users = await db.select(db.users).get();
    expect(users.single.name, 'たろう');
    await db.close();
  });
}
dart run build_runner build
flutter test

テーブルを変えるときは

スキーマの変更と移行

schemaVersion を1つ上げ、MigrationStrategy の onUpgrade に移行処理(列の追加など)を書きます。配布前ならアプリを削除して作り直してもかまいません。

チェックポイント

CHECK 0 / 3