platform/packages/orm/angel_migration_runner/README.md

25 lines
1.3 KiB
Markdown
Raw Normal View History

2021-07-19 04:49:31 +00:00
# Angel3 Migration Runner
2021-12-20 04:25:43 +00:00
![Pub Version (including pre-releases)](https://img.shields.io/pub/v/angel3_migration_runner?include_prereleases)
2021-05-18 14:36:40 +00:00
[![Null Safety](https://img.shields.io/badge/null-safety-brightgreen)](https://dart.dev/null-safety)
[![Gitter](https://img.shields.io/gitter/room/angel_dart/discussion)](https://gitter.im/angel_dart/discussion)
2021-12-20 04:25:43 +00:00
[![License](https://img.shields.io/github/license/dukefirehawk/angel)](https://github.com/dukefirehawk/angel/tree/master/packages/orm/angel_migration_runner/LICENSE)
2021-05-18 14:36:40 +00:00
2021-07-19 04:49:31 +00:00
Command-line based database migration runner for Angel3 ORM.
Supported database:
2022-01-02 10:46:59 +00:00
* PostgreSQL version 10 or later
2022-05-01 09:40:42 +00:00
* MariaDB 10.2.x or later
* MySQL 8.x or later
## Usage
* For PostgreSQL, use `PostgresMigrationRunner` to perform the database migration.
* For MariaDB, use `MariaDbMigrationRunner` to perform the database migration.
* For MySQL, use `MySqlMigrationRunner` to perform the database migration.
**Important Notes** For MariaDB and MySQL, both migration runner are using different drivers. MariaDB is using `mysql1` driver while MySQL is using `mysql_client` driver. This is necessary as neither driver works correctly over both MariaDB and MySQL. Based on testing, `mysql1` driver works seamlessly with MariaDB 10.2.x while `mysql_client` works well with MySQL 8.x.