andreyryabin/sprint.migration

bitrix migration module

4.6.1 2023-10-23 20:16 UTC

Requires

• php: >=7.0
• ext-iconv: *
• ext-json: *
• composer/installers: ~1

MIT

• Andrey Ryabin

• migration
• bitrix
• sprint
• andrey
• ryabin

README

Помогает переносить изменения между нескольким копиями проекта.

Все изменения для базы данных пишутся в файлы миграций, эти файлы, как и весь код проекта, хранятся в системе контроля версий (например git) и попадают в копии разработчиков, после чего им необходимо выполнить установку новых миграций, чтобы обновить бд.

Работать можно как через консоль, так и через админку.

• Маркетплейс: http://marketplace.1c-bitrix.ru/solutions/sprint.migration/
• Composer: https://packagist.org/packages/andreyryabin/sprint.migration
• Документация: https://github.com/andreyryabin/sprint.migration/wiki
• Материалы: https://dev.1c-bitrix.ru/community/webdev/user/39653/blog/
• Группа в телеграм: https://t.me/sprint_migration_bitrix

Особая благодарность

Самой лучшей IDE на свете!

А также всем помощникам!
https://github.com/andreyryabin/sprint.migration/blob/master/contributors.txt

Установка через composer

Пример вашего composer.json с установкой модуля в local/modules/

{
  "extra": {
    "installer-paths": {
      "local/modules/{$name}/": ["type:bitrix-module"]
    }
  },
  "require": {
    "andreyryabin/sprint.migration": "dev-master"
  },
}

Консоль

Для работы через консоль используется скрипт /bitrix/modules/sprint.migration/tools/migrate.php

Можно запускать его напрямую или сделать алиас, создав файл в корне проекта, bin/migrate и прописав в нем:

#!/usr/bin/env php
<?php

$_SERVER['DOCUMENT_ROOT'] = dirname(__DIR__);
require_once $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/sprint.migration/tools/migrate.php';

Консоль symfony

Если у вас используется связка bitrix + symfony, то можно подключить модуль как бандл симфони и запускать консольные команды модуля через

php bin/console sprint:migration

Пример регистрации бандла:

// app/AppKernel.php
use Sprint\Migration\SymfonyBundle\SprintMigrationBundle;

public function registerBundles()
{
    $bundles = array(
        new SprintMigrationBundle(),
    );
    return $bundles;
}

Пример без регистрации бандла, только команды в symfony/console

// bin/console
use Sprint\Migration\SymfonyBundle\Command\ConsoleCommand;
use Symfony\Component\Console\Application;

$app = new Application();
$app->add(new ConsoleCommand());

$app->run();

Классы модуля должны уже быть автозагружены, через CModule::IncludeModule('sprint.migration')

Или через библиотеку https://packagist.org/packages/webarchitect609/bitrix-neverinclude (рекомендую этот вариант)

Примеры команд

• php bin/migrate add (создать новую миграцию)
• php bin/migrate ls (показать список миграций )
• php bin/migrate up (накатить все миграции)
• php bin/migrate up [version] (накатить выбранную миграцию)
• php bin/migrate down (откатить все миграции)
• php bin/migrate down [version] (откатить выбранную миграцию)

Все команды: https://github.com/andreyryabin/sprint.migration/blob/master/commands.txt

Скриншоты

Админка миграций

Формы создания миграций