dtforce/fornettey-doctrine-migrations

Implementation of Doctrine Migrations for Nette

v0.1.2-beta 2016-01-22 18:53 UTC

This package is not auto-updated.

Last update: 2024-11-09 19:19:51 UTC


README

Implementation of Doctrine\Migrations to Nette.

Install

composer require dtforce/doctrine-migrations

Register extensions in config.neon:

extensions:
	migrations: DTForce\DoctrineMigrations\DI\MigrationsExtension

Configuration

config.neon with default values

migrations:
	table: doctrine_migrations # database table for applied migrations
	directory: %appDir%/../migrations # directory, where all migrations are stored
	namespace: Migrations # namespace of migration classes

Usage

Open your CLI and run command (based on DTForce\NetteConsole integration):

php bin/console

Migrate changes to database

If you want to migrate existing migration to your database, just run migrate commmand:

php bin/console migrations:migrate

If you get lost, just use -h option for help:

php bin/console migrations:migrate -h

Create new migration

To create new empty migration, just run:

php bin/console migrations:generate

A new empty migration will be created at your migrations directory. You can add your sql there then.

Migration that would add new role "superadmin" to user_role table would look like this:

namespace Migrations;

use Doctrine\DBAL\Migrations\AbstractMigration;
use Doctrine\DBAL\Schema\Schema;


/**
 * New role "superadmin" added.
 */
final class Version20151015000003 extends AbstractMigration
{

	/**
	 * {@inheritdoc}
	 */
	public function up(Schema $schema)
	{
		$this->addSql("INSERT INTO 'user_role' (id, value, name) VALUES (3, 'superadmin', 'Super Admin')");
	}
	

	/**
	 * {@inheritdoc}
	 */
	public function down(Schema $schema)
	{
		$this->addSql("DELETE FROM 'user_role' WHERE ('id' = 3);");
	}

}

As simple as that!

For further use, please check docs in Symfony bundle.

Features

Cleanup your directories

If you have over 100 migrations in one directory, it might get messy. How to make it nicer? You can create a subdirectory and move some migrations there. I would group them up by year or by purpose. All subdirectories of directory you set up in configuration will be scanned.

It can look like this:

/migrations/
   - VersionZZZ.php
/migrations/2015/
   - VersionYYY.php
/migrations/basic-data
   - VersionXXXX.php

Injected migrations

namespace Migrations;


final class Version20140801152432 extends AbstractMigration
{

	/**
	 * @inject
	 * @var Doctrine\ORM\EntityManagerInterface
	 */
	public $entityManager;


	public function up(Schema $schema)
	{
		// ...
	}

	// ...

}