README

Миграция данных БД для Laravel

Данный пакет добавляет в ваше Laravel-приложение функционал мигрирования данных БД.

Install

Require this package with composer using the following command:

$ composer require avto-dev/data-migrations-laravel "^2.4"

Installed composer is required (how to install composer).

You need to fix the major version of package.

Опубликуйте конфигурационный файл, при помощи которого вы можете переопределить имя таблицы в БД для хранения данных о миграциях, имя соединения и прочие настройки:

$ php ./artisan vendor:publish --provider="AvtoDev\\DataMigrationsLaravel\\ServiceProvider"

После чего отредактируйте файл ./config/data-migrations.php на своё усмотрение и завершите установку, выполнив команду:

$ php ./artisan data-migrate:install

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

Проблема, которую решает данный пакет - это отсутствие встроенного в Laravel механизма мигрирования "боевых" данных в ваше приложение (seeds это механизм заполнения фейковыми данными изначально, а миграции БД несут ответственность за схему и т.д., но не данные).

Для того, что бы лучше ознакомиться с "механикой" работы данного пакета рассмотрим следующую ситуацию - ваше приложение использует 2 подключения к различным БД (default и second_db), и вам необходимо в каждом из них в уже существующие таблицы добавить какие-либо данные.

Для этого вам необходимо выполнить 2 команды:

$ ./artisan make:data-migration "Add some data into first table"
$ ./artisan make:data-migration --connection="second_db" "Add some data into second table"

После выполнения которых создадутся 2 файла:

./storage/data_migrations/2018_01_01_022000_add_some_data_into_first_table.sql
./storage/data_migrations/second_db/2018_01_01_022001_add_some_data_into_second_table.sql

Которые вы можете наполнить SQL-командами, производящими необходимые insert-ы и так далее (помните, что идеологически верно использовать их только для манипуляций с данными).

После этого вам достаточно выполнить:

$ ./artisan data-migrate

И данная команда произведёт поиск всех файлов (за исключением тех, чьи имена начинаются с точки) в директории ./storage/data_migrations (путь может быть переопределен в конфигурационном файле) и попытается их выполнить, если запись об их выполнении не будет обнаружена в таблице migrations_data (которая была создана командой data-migrate:install).

Особенности

При использовании данного пакета следует знать о следующих особенностях:

Если в директории с файлами-миграциями данных ./storage/data_migrations создать новую директорию, и уже в ней разместить файл-миграцию - то имя этой директории будет использовано как имя подключения к БД (описанное в файле ./config/database.php), которое надо использовать для применения миграций, что в ней размещены;
Для применения миграций используются специальные классы, реализующие интерфейс ExecutorContract. Вы можете создать свой, указав его полное имя в файле-конфигурации;
Миграции могут быть упакованы с помощью gzip (gzip file.sql). При наличии установленного php-расширения zlib они распаковываются "на лету", главное чтоб имя файла миграции заканчивалось на .gz;
Миграции не имеют механизма "отката" (rollback-ов).

Artisan-команды

После установки данного пакета вам станут доступны следующие команды:

Сигнатура команды	Описание
`data-migrate:install`	Производит создание таблицы в БД для хранения данных о миграциях данных
`make:data-migration`	Создаёт файл-миграции (пустой) в соответствии с необходимыми правилами именования и расположения
`data-migrate`	Запускает механизм мигрирования данных
`data-migrate:status`	Выводит данные о примененных и не примененных миграциях
`data-migrate:uninstall`	Удаляет таблицу с данными о миграциях данных из БД

Testing

For package testing we use phpunit framework and docker-ce + docker-compose as develop environment. So, just write into your terminal after repository cloning:

$ make build
$ make latest # or 'make lowest'
$ make test

Changes log

Changes log can be found here.

Support

If you will find any package errors, please, make an issue in current repository.

License

This is open-sourced software licensed under the MIT License.

avto-dev / data-migrations-laravel

Maintainers

Details