platform/packages/orm/angel_migration_runner/README.md
2024-10-12 18:45:27 -07:00

1.4 KiB
Executable file

Protevus Migration Runner

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

This package contains the implementation of the database migration for the following databases. It is designed to work with Protevus ORM.

  • 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

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

Limitation

  • Update schema changes is not supported