platform/packages/orm/angel_migration_runner/README.md

# Protevus Migration Runner

![Pub Version (including pre-releases)](https://img.shields.io/pub/v/protevus_migration_runner?include_prereleases)
[![Null Safety](https://img.shields.io/badge/null-safety-brightgreen)](https://dart.dev/null-safety)
[![Discord](https://img.shields.io/discord/1060322353214660698)](https://discord.gg/3X6bxTUdCM)
[![License](https://img.shields.io/github/license/dart-backend/protevus)](https://github.com/dart-backend/protevus/tree/master/packages/orm/angel_migration_runner/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`](https://pub.dev/packages?q=mysql_client) driver.
* Use `MariaDbMigrationRunner` to perform database migration for MariaDB. This runner is using [`mysql1`](https://pub.dev/packages?q=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
Refactor: changing namespace, imports, re-branding 2024-10-12 10:35:14 +00:00			`# Protevus Migration Runner`
Updated angel_migration_runner 2021-07-19 04:49:31 +00:00
Refactor: changing namespace, imports, re-branding 2024-10-13 01:45:27 +00:00			`![Pub Version (including pre-releases)](https://img.shields.io/pub/v/protevus_migration_runner?include_prereleases)`
Published migration_runner 2021-05-18 14:36:40 +00:00			`[![Null Safety](https://img.shields.io/badge/null-safety-brightgreen)](https://dart.dev/null-safety)`
Replaced Gitter with Discord chat 2024-07-07 15:02:49 +00:00			`[![Discord](https://img.shields.io/discord/1060322353214660698)](https://discord.gg/3X6bxTUdCM)`
Refactor: changing namespace, imports, re-branding 2024-10-12 10:35:14 +00:00			`[![License](https://img.shields.io/github/license/dart-backend/protevus)](https://github.com/dart-backend/protevus/tree/master/packages/orm/angel_migration_runner/LICENSE)`
Published migration_runner 2021-05-18 14:36:40 +00:00
Refactor: changing namespace, imports, re-branding 2024-10-12 10:35:14 +00:00			`This package contains the implementation of the database migration for the following databases. It is designed to work with Protevus ORM.`
Updated angel_migration_runner 2021-07-19 04:49:31 +00:00
Fixed migration runner for MySQL 2022-07-27 14:21:36 +00:00			`* PostgreSQL 10.x or greater`
			`* MariaDB 10.2.x or greater`
			`* MySQL 8.x or greater`
Updated Change Log 2022-05-01 09:40:42 +00:00
			`## Usage`

Fixed migration runner for MySQL 2022-07-27 14:21:36 +00:00			* Use `PostgresMigrationRunner` to perform database migration for PostgreSQL.
			* Use `MySqlMigrationRunner` to perform database migration for MySQL and MariaDB. This runner is using [`mysql_client`](https://pub.dev/packages?q=mysql_client) driver.
Updated change log 2024-01-25 04:48:43 +00:00			* Use `MariaDbMigrationRunner` to perform database migration for MariaDB. This runner is using [`mysql1`](https://pub.dev/packages?q=mysql1) driver.
Fixed migration runner for MySQL 2022-07-27 14:21:36 +00:00
			`## Supported Operations`

Updated change log 2024-01-25 04:48:43 +00:00			`* up - Generate all the tables based on the ORM models.`
Fixed mariadb issue 2024-07-21 03:16:49 +00:00			* reset - Clear out all records in the `migrations` table and drop all the ORM related tables.
Fixed migration runner for MySQL 2022-07-27 14:21:36 +00:00			* refresh - Run `reset` follow by `up`
Updated change log 2024-01-25 04:48:43 +00:00
Fixed mariadb issue 2024-07-21 03:16:49 +00:00			`## Limitation`
Updated change log 2024-01-25 04:48:43 +00:00
Fixed mariadb issue 2024-07-21 03:16:49 +00:00			`* Update schema changes is not supported`