Flutter迁移工具插件angel3_migration_runner的使用

Flutter迁移工具插件angel3_migration_runner的使用

本包包含以下数据库的迁移实现。它设计用于与Angel3 ORM配合使用。

• PostgreSQL 10.x 或更高版本
• MariaDB 10.2.x 或更高版本
• MySQL 8.x 或更高版本

使用方法

• 使用 PostgresMigrationRunner 进行 PostgreSQL 数据库迁移。
• 使用 MySqlMigrationRunner 进行 MySQL 和 MariaDB 数据库迁移。此运行器使用 mysql_client 驱动。
• 使用 MariaDbMigrationRunner 进行 MariaDB 数据库迁移。此运行器使用 mysql1 驱动。

支持的操作

• up - 基于ORM模型生成所有表。
• reset - 清除 migrations 表中的所有记录并删除所有与ORM相关的表。
• refresh - 运行 reset 后跟随 up。

限制

• 不支持更新模式更改。

完整示例代码

import 'dart:io';

import 'package:angel3_migration/angel3_migration.dart';
import 'package:angel3_migration_runner/angel3_migration_runner.dart';
import 'package:angel3_migration_runner/mysql.dart';
import 'package:angel3_migration_runner/postgres.dart';
import 'package:angel3_orm/angel3_orm.dart';
import 'package:mysql_client/mysql_client.dart';
import 'package:postgres/postgres.dart';

import 'todo.dart';

void main(List<String> args) async {
  // 在PostgreSQL数据库上运行迁移
  postgresqlMigration(args);

  // 在MySQL数据库上运行迁移
  mysqlMigration(args);
}

void postgresqlMigration(List<String> args) async {
  var host = Platform.environment['DB_HOST'] ?? 'localhost';
  var database = Platform.environment['DB_NAME'] ?? 'demo';
  var username = Platform.environment['DB_USERNAME'] ?? 'demouser';
  var password = Platform.environment['DB_PASSWORD'] ?? 'demo123';

  print("$host $database $username $password");

  Connection conn = await Connection.open(
      Endpoint(
          host: host,
          port: 5432,
          database: database,
          username: username,
          password: password),
      settings: ConnectionSettings(sslMode: SslMode.disable));

  var runner = PostgresMigrationRunner(
    conn,
    migrations: [
      UserMigration(),
      TodoMigration(),
      FooMigration(),
    ],
  );

  runMigrations(runner, args);
}

void mysqlMigration(List<String> args) async {
  var host = Platform.environment['MYSQL_HOST'] ?? 'localhost';
  var database = Platform.environment['MYSQL_DB'] ?? 'orm_test';
  var username = Platform.environment['MYSQL_USERNAME'] ?? 'test';
  var password = Platform.environment['MYSQL_PASSWORD'] ?? 'test123';

  var mySQLConn = await MySQLConnection.createConnection(
      host: host,
      port: 3306,
      databaseName: database,
      userName: username,
      password: password,
      secure: true);

  // 忽略：未使用的局部变量
  var runner = MySqlMigrationRunner(
    mySQLConn,
    migrations: [
      UserMigration(),
      TodoMigration(),
      FooMigration(),
    ],
  );

  runMigrations(runner, args);
}

class FooMigration extends Migration {
  [@override](/user/override)
  void up(Schema schema) {
    schema.create('foos', (table) {
      table
        ..serial('id').primaryKey() // 创建一个名为id的自增主键
        ..varChar('bar', length: 64) // 创建一个名为bar的varchar类型字段，长度为64
        ..timeStamp('created_at').defaultsTo(currentTimestamp); // 创建一个名为created_at的时间戳字段，默认值为当前时间
    });
  }

  [@override](/user/override)
  void down(Schema schema) => schema.drop('foos'); // 删除名为foos的表
}