Базовые миграции для фреймворка HLEB2

Эти миграции реализуют минимальный набор стандартных действий, основное их предназначение - выполнить заготовленные запросы и зафиксировать в базе данных факт их выполнения, предотвращая повторное. Для этого во фреймворке должна быть подключена база данных.

Поддержка MySQL / MariaDB / PostgreSQL

Установка

composer require phphleb/migration

Развертывание

php console phphleb/migration add

Использование

Далее можно создать шаблон миграции при помощи консольной команды:

php console migration/create example_name

Эта команда создаст в папке database/migrations (или migrations при её отсутствии) проекта новую миграцию с именем 'Migration_XXX_example_name.php' (где индекс ХХХ - текущее UNIX-время в миллисекундах). Если папки database/migrations или migrations нет в корневой директории проекта, то нужно создать её вручную. Если эта папка вас не устраивает, нужно будет переписать классы консольных команд с указанием директории и использовать собственные, развертывание библиотеки при этом можно не применять. Но если используется одна база данных, этих двух вариантов расположения должно хватить (должен использоваться только один из них).

В классе 'Migration_XXX_example_name' файла миграции есть метод up(), в который можно добавить один или более SQL-запросов с помощью метода addSql(...). Аналогичным образом в методе down() содержатся запросы, которые откатывают выполнение метода up(). С откатом миграций нужно быть осторожным, многие его не используют, но если он обязателен в проекте, нужно следить за его актуальностью.

<?php

class Migration_XXX_example_name extends \Phphleb\Migration\Src\StandardMigration
{
   public function up(PDO $db)
   {
      $this->addSql("CREATE TABLE table_name (cell_id int)");
   }

   public function down()
   {
      $this->addSql("DROP TABLE table_name");
   }

}

Также есть команда для выполнения миграций:

php console migration/run --no-notify

Выполнит все незафиксированные миграции (ранее не выполненные) и зафиксирует их в таблице migrations базы данных, последняя указана в настройках проекта (конфигурации БД) как основная. Соответственно, все SQL-запросы миграций могут быть выполнены только к этой БД. Если убрать --no-notify, то будут выведены подробности выполнения команды.

Для второстепенной базы данных из конфигурации фреймворка также можно дополнительно создать свои консольные команды (create, rollback, run и status) с указанием конкретного названия подключения из конфигурации БД. Например: new Migration(DB::getPdoInstance("mysql.other-name"), "other_migrations_table", "other_migrations_path"). А если вариантов несколько, то можно передавать их в виде аргумента, не создавая для каждой отдельные консольные команды. Для разных вариантов подключения нужно указать и разные таблицы хранения, а также папки, как в примере.

Перед выполнением миграций эта команда поможет уточнить список незафиксированных миграций в проекте, не выполняя сами миграции:

php console migration/status

Следующая команда предназначена для отката миграций. Если при выполнении использовались запросы из метода up(), то теперь выполнятся из метода down(). Порядок выполнения миграций будет в обратном порядке, то есть сначала выполнится последняя зафиксированная, потом предпоследняя и тд. Если указать число в виде аргумента команды, то на это количество миграций произойдёт откат. По умолчанию (без аргумента) на одну. Если нужно откатить все миграции, то нужно аргументом указать 'all', будет применено ко всем существующим миграциям c очисткой таблицы с ними в БД.

php console migration/rollback all --no-notify

При выполнении указанной команды будет произведён откат на две миграции с конца. Отсчет идёт с зафиксированных миграций, уже выполненных.

В случае, если вы хотите добавить миграции на уже существующий проект с базой данных некоторого размера, создайте первую миграцию из дампа структуры этой БД, добавив к созданию таблиц выражение 'IF NOT EXISTS', после чего выполните миграции.

Произвольная установка

Присутствует возможность использовать этот механизм миграций вне фреймворка HLEB2, а в любом PHP-проекте. Принцип подключения можно найти в консольных командах этой библиотеки, подключение там реализовано так:

use Hleb\Static\DB;
use Phphleb\Migration\Src\Migration;

(new Migration(DB::getPdoInstance(), 'migrations', '/path/to/migrations/'))->run();

где первым аргументом конструктора класса Migration подаётся инициализированный объект PDO, вторым - название таблицы для сохранения данных миграций (по умолчанию 'migrations'), а третьим полный путь к папке для хранения файлов миграций. Достаточно реализовать подобные консольные команды с подстановкой собственных аргументов.

Обновление

composer update phphleb/migration

php console phphleb/migration add

composer dump-autoload