dox_migration 3.0.0-alpha.5

Database migration package for Postgres, MySQL, MariaDB and SQLite

dox_migration

Database migrations in Dart for Postgres, MySQL, MariaDB and SQLite.

Part of Dox, a web backend framework for Dart, like Laravel. Source code: github.com/dartondox/dox.

Install

dart pub add dox_migration

The dox CLI makes the files and runs the commands. A new app made with dox create already has it.

Dox 3.x is in alpha (3.0.0-alpha.4). The API can still change before the stable release.

Use it

dox make:migration create_users_table makes this file:

import 'package:dox_migration/dox_migration.dart';

class CreateUsersTable extends Migration {
  @override
  Future<void> up(Schema schema) async {
    await schema.create('users', (Table table) {
      table.id();
      table.string('email').unique();
      table.timestamps();
    });
  }

  @override
  Future<void> down(Schema schema) async {
    await schema.dropIfExists('users');
  }
}

It also writes the list of migrations (db/migration/migrations.dart) and bin/migrate.dart. Then run:

dox migration:run        # or: dox migrate
dox migration:rollback
dox migration:status

The server binary can run them at start:

Dox().initialize(appConfig);
await Migrator(migrations: migrations).migrate();
await Dox().startServer();

Features

• One Dart migration works on Postgres, MySQL, MariaDB and SQLite.
• Plain .sql migrations work too, in the same folder.
• Run, rollback (by batch or --step), reset, refresh and status.
• Each migration runs in one transaction. On MySQL, CREATE, ALTER and DROP can not be undone.
• The migration list is compiled in, so an AOT binary can migrate.
• Reads the database settings from DATABASE_URL, or DB_CONNECTION, DB_HOST, ... A real env var wins over .env.

Documentation

• Migration and Schema
• API reference

License

MIT. See LICENSE.