Skip to content

Migration

You can use doctrine migration, which is known from doctrine orm, to create your schema and keep it in sync.

Warning

To use the migration CLI commands, you have to configure the CLI beforehand.

Installation

In order to be able to use doctrine/migrations, you have to install the associated package.

composer require doctrine/migrations

Configure Migration Schema Provider

We have added a schema provider for doctrine migrations so that you just have to plug the whole thing together.

use Patchlevel\EventSourcing\Schema\MigrationSchemaProvider;

$schemaProvider = new MigrationSchemaProvider($store);

CLI example

You can plug this together, for example, as follows to create CLI applications like cli.php:

use Doctrine\DBAL\DriverManager;
use Doctrine\Migrations\DependencyFactory;
use Doctrine\Migrations\Configuration\Migration\PhpFile;
use Doctrine\Migrations\Configuration\Connection\ExistingConnection;
use Doctrine\Migrations\Tools\Console\Command;
use Symfony\Component\Console\Application;

$connection = DriverManager::getConnection([
    'url' => 'mysql://user:secret@localhost/app'
]);

$config = new PhpFile('migrations.php');

$dependencyFactory = DependencyFactory::fromConnection(
    $config, 
    new ExistingConnection($connection)
);

$store = /* define your doctrine store */;

$dependencyFactory->setService(
    SchemaProvider::class, 
    new MigrationSchemaProvider($store)
);

$cli = new Application('Event-Sourcing CLI');
$cli->setCatchExceptions(true);

$cli->addCommands([

    // other cli commands

    new Command\ExecuteCommand($dependencyFactory, 'event-sourcing:migrations:execute'),
    new Command\GenerateCommand($dependencyFactory, 'event-sourcing:migrations:generate'),
    new Command\LatestCommand($dependencyFactory, 'event-sourcing:migrations:latest'),
    new Command\ListCommand($dependencyFactory, 'event-sourcing:migrations:list'),
    new Command\MigrateCommand($dependencyFactory, 'event-sourcing:migrations:migrate'),
    new Command\DiffCommand($dependencyFactory, 'event-sourcing:migrations:diff'),
    new Command\StatusCommand($dependencyFactory, 'event-sourcing:migrations:status'),
    new Command\VersionCommand($dependencyFactory, 'event-sourcing:migrations:version'),
]);

$cli->run();

Note

Here you can find more information on how to configure doctrine migration.

Migration commands

There are some commands to use the migration feature.

  • ExecuteCommand: event-sourcing:migrations:execute
  • GenerateCommand: event-sourcing:migrations:generate
  • LatestCommand: event-sourcing:migrations:latest
  • ListCommand: event-sourcing:migrations:list
  • MigrateCommand: event-sourcing:migrations:migrate
  • DiffCommand: event-sourcing:migrations:diff
  • StatusCommand: event-sourcing:migrations:status
  • VersionCommand: event-sourcing:migrations:version