-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
d444375
commit bfba1b9
Showing
3 changed files
with
204 additions
and
45 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,13 @@ | ||
| # Release Notes | ||
|
|
||
| ## [0.2.1 (2019-06-09)](https://github.com/maxim-oleinik/blade-migrations/compare/0.2.0...0.2.1) | ||
| ## [0.2.2 (2019-08-10)](https://github.com/maxim-oleinik/blade-migrations/compare/0.2.1...0.2.2) | ||
| #### Changed | ||
| - Minor refactoring | ||
|
|
||
|
|
||
| ## [0.2.1 (2019-06-09)](https://github.com/maxim-oleinik/blade-migrations/compare/0.2.0...0.2.1) | ||
| #### Added | ||
| - `Migrate` - добавил режим тестировавания Rollback (UP-DOWN-UP) | ||
| - `Migrate` - add rollback test mode (UP-DOWN-UP) | ||
|
|
||
| #### Changed | ||
| - `Status` - поменял цветовую схему - зеленый для новых миграций |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| Blade/Migrations | ||
| ================ | ||
|
|
||
| [](https://packagist.org/packages/maxim-oleinik/blade-migrations) | ||
| <a href="https://packagist.org/packages/maxim-oleinik/blade-migrations"><img src="https://poser.pugx.org/maxim-oleinik/blade-migrations/d/total.svg" alt="Total Downloads"></a> | ||
| <a href="https://packagist.org/packages/maxim-oleinik/blade-migrations"><img src="https://poser.pugx.org/maxim-oleinik/blade-migrations/license.svg" alt="License"></a> | ||
|
|
||
| Библиотека предоставляет API для реализации команд управления миграциями структуры БД | ||
| * Symfony/Console - https://github.com/maxim-oleinik/blade-migrations-symfony | ||
| * Laravel/Artisan - https://github.com/maxim-oleinik/blade-migrations-laravel | ||
|
|
||
| **Особенности:** | ||
| * миграции на чистом SQL (на любом нативном языке БД) | ||
| * нет своего конфига и коннекта к БД - использует существующее в проекте соединение. Можно использовать для миграций любых баз. | ||
| * автоматический откат миграций созданных в других ветках | ||
|
|
||
|
|
||
| Синтаксис | ||
| --------- | ||
| * `--TRANSACTION` - если указано, то миграция будет запущена в транзакции | ||
| * Инструкции разделяются тегами `--UP` и `--DOWN` | ||
| * SQL запросы разделяются `";"` (последний символ в конце строки) | ||
| ``` | ||
| --TRANSACTION | ||
| --UP | ||
| ALTER TABLE authors ADD COLUMN code INT; | ||
| ALTER TABLE posts ADD COLUMN slug TEXT; | ||
| --DOWN | ||
| ALTER TABLE authors DROP COLUMN code; | ||
| ALTER TABLE posts DROP COLUMN slug; | ||
| ``` | ||
|
|
||
| **Если надо сменить разделитель**, когда в SQL необходимо использовать `";"` | ||
| ``` | ||
| --SEPARATOR=@ | ||
| --UP | ||
| ... some sql ...@ | ||
| ... some sql ...@ | ||
| --DOWN | ||
| ... some sql ...@ | ||
| ... some sql ...@ | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
|
|
||
| Установка и настройка | ||
| --------- | ||
|
|
||
| 1. Добавить с помощью **composer** | ||
| ``` | ||
| composer require maxim-oleinik/blade-migrations | ||
| ``` | ||
|
|
||
| 2. Подключить к своей БД - необходимо реализовать интерфейс `\Blade\Database\DbConnectionInterface` | ||
| см. https://github.com/maxim-oleinik/blade-database | ||
|
|
||
| 3. Сборка | ||
| ``` | ||
| $conn = new MyDbConnection; // implements \Blade\Database\DbConnectionInterface | ||
| $dbAdapter = new \Blade\Database\DbAdapter($conn); | ||
| $repoDb = new \Blade\Migrations\Repository\DbRepository($migrationTableName = 'migrations', $dbAdapter); | ||
| $repoFile = new \Blade\Migrations\Repository\FileRepository($migrationsDir = __DIR__ . '/migrations'); | ||
| $service = new \Blade\Migrations\MigrationService($repoFile, $repoDb); | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
| Команды | ||
| ------- | ||
|
|
||
| ### Status - `\Blade\Migrations\Operation\StatusOperation` | ||
| ``` | ||
| $op = new \Blade\Migrations\Operation\StatusOperation($service); | ||
| $data = $op->getData(); | ||
| ``` | ||
|
|
||
| Возвращает массив массив данных по текущему состоянию миграций | ||
| ``` | ||
| [ | ||
| [ | ||
| CODE, | ||
| ID, | ||
| DATE, | ||
| NAME, | ||
| ], | ||
| ] | ||
| ``` | ||
| Где CODE: | ||
| * Y - выполнена | ||
| * D - требует отката (в текущей ветке ее нет) | ||
| * A - в очереди | ||
|
|
||
|
|
||
| ### Migrate - `\Blade\Migrations\Operation\MigrateOperation` | ||
| ``` | ||
| $op = new \Blade\Migrations\Operation\MigrateOperation($service); | ||
| // Передать логгер в миграцию для вывода данных | ||
| $op->setLogger(\Psr\Log\LoggerInterface $logger); | ||
| $op->setAuto(bool); // Автооткат отсутствющих в текущей ветке миграций (есть в базе, но нет на диске) | ||
| $op->setForce(bool); // Не спрашивать подтверждение | ||
| $op->setTestRollback(bool); // Протестирововать откат миграции в режиме UP-DOWN-UP | ||
| /** | ||
| * @param $confirmationCallback - функция, которая спросит подтверждение у пользователя и вернет true/false | ||
| * @param $migrationName - Название миграции. Если указано, принудительно запустит ее вне очереди | ||
| */ | ||
| $op->run(callable $confirmationCallback($migrationTitle), $migrationName = null); | ||
| ``` | ||
|
|
||
|
|
||
| ### Rollback - `\Blade\Migrations\Operation\RollbackOperation` | ||
| ``` | ||
| $op = new \Blade\Migrations\Operation\RollbackOperation($service); | ||
| // Передать логгер в миграцию для вывода данных | ||
| $op->setLogger(\Psr\Log\LoggerInterface $logger); | ||
| $op->setForce(bool); // Не спрашивать подтверждение | ||
| /** | ||
| * @param $confirmationCallback - функция, которая спросит подтверждение у пользователя и вернет true/false | ||
| * @param $migrationId - ID миграции в базе. Если указано, принудительно откатит ее вне очереди | ||
| * @param $loadFromFile - Загрузить миграцию из файла, а не из БД (например, если в базу попала ошибка) | ||
| */ | ||
| $op->run(callable $confirmationCallback($migrationTitle), $migrationId = null, $loadFromFile = false); | ||
| ``` | ||
|
|
||
| ### Создать миграцию - `\Blade\Migrations\Operation\MakeOperation` | ||
| ``` | ||
| $op = new \Blade\Migrations\Operation\MakeOperation($repoFile) | ||
| $op->run($migrationFileName); | ||
| ``` | ||
|
|
||
| ### Install - `\Blade\Migrations\Repository\DbRepository` | ||
| Создать таблицу миграций в Базе | ||
| ``` | ||
| $repoDb->install(); | ||
| ``` |