platform/packages/orm/angel_migration_runner/README.md
2024-07-07 23:02:49 +08:00

1.3 KiB
Executable file

Angel3 Migration Runner

Pub Version (including pre-releases) Null Safety Discord License

Database migration runner for Angel3 ORM.

Supported database:

  • PostgreSQL 10.x or greater
  • MariaDB 10.2.x or greater
  • MySQL 8.x or greater

Usage

  • Use PostgresMigrationRunner to perform database migration for PostgreSQL.

  • Use MySqlMigrationRunner to perform database migration for MySQL and MariaDB. This runner is using mysql_client driver.

  • Use MariaDbMigrationRunner to perform database migration for MariaDB. This runner is using mysql1 driver.

Supported Operations

  • reset - Clear out all records in the migrations table and drop all the ORM related tables.
  • up - Generate all the tables based on the ORM models.
  • refresh - Run reset follow by up

To do

  • Update existing tables
  • Reverse engineer tables into models