getting_started.md

Getting started with CoopTilleulsMigrationBundle

Installation

Installing CoopTilleulsMigrationBundle can be done easily through Composer. Update your composer.json file as following:

{
    ...
    "require": [
        ...
        "tilleuls/migration-bundle": "^1.1"
    ]
}

Register this bundle in your kernel:

// app/AppKernel.php
public function registerBundles()
{
    $bundles = [
        new CoopTilleuls\MigrationBundle\CoopTilleulsMigrationBundle(),
        // ...
    ];

    // ...
}

Configuration

Configure legacy connection

Assuming you have 2 bundles: AppBundle for your final application, and MigrationBundle which manages migration.

This bundle requires to connect to 2 connections: default & legacy. Legacy connection represents the connection to the old database:

doctrine:
    dbal:
        default_connection: default
        connections:
            default:
                url: "%env(DATABASE_URL)%"
            legacy:
                wrapper_class: 'CoopTilleuls\MigrationBundle\Doctrine\DBAL\DisabledConnection'
                url: "%env(LEGACY_DATABASE_URL)%"
    orm:
        default_entity_manager: default
        entity_managers:
            default:
                connection: default
                mappings:
                    AppBundle:  ~
            legacy:
                connection: legacy
                mappings:
                    MigrationBundle: ~

This configuration describes the 2 connections (default & legacy) with their own entity manager.

See the wrapper_class parameter on the legacy connection: it allows MigrationBundle to disable commit during the transformers process due to security reasons. MigrationBundle has to ensure that if an error occurred in any transaction (flush on the legacy database or on the current one) on the transformers process, all transactions must be rollbacked.

Configure your application

Enable required configuration. You must provide the name of the Doctrine legacy connection:

# app/config/config.yml
coop_tilleuls_migration:
    legacy_connection_name: 'legacy'

Loaders

At the init of the application, it'll be necessary to import data from the old database to the new one. This is the main goal of loaders.

Read full documentation about loaders.

Transformers

Once both applications are online, it's necessary to keep both databases synchronized. To do so, the main system must write data in the old database.

Read full documentation about transformers.