fabiopaiva/pdo-simple-migration

Database version control using PDO connection

PDO Simple Migration

Simple migration is a minimalist tool to manage your database versioning., _(*1)

Installation

composer require fabiopaiva/pdo-simple-migration

, _(*2)

Configuration

This library tries to find a file called config.php in working directory with PDO setup, if file doesn't exist, you can send PDO parameters in command line., _(*3)

config.php (optional)

``` php <?php return [ 'db' => [ 'dsn' => 'mysql:host=localhost;dbname=myDb;port=3306;charset=UTF8', 'username' => 'root', 'password' => 'pass', ], 'table' => 'migrations', 'dir' => 'migrations' ];, <sub>(*4)</sub>

`table` is the name of database table to control your versioning, migrations is default.

`dir` is the path where you want to store you migrations file.

## Usage

### Status

List current status of your migrations

    vendor/bin/migration status

![Status](https://github.com/fabiopaiva/PDOSimpleMigration/blob/master/docs/status.png)

### Generate

Generate a empty migration

    vendor/bin/migration generate

![Generate](https://github.com/fabiopaiva/PDOSimpleMigration/blob/master/docs/generate.png)

#### Generated code example

``` php
<?php

namespace PDOSimpleMigration\Migrations;

use PDOSimpleMigration\Library\AbstractMigration;

class Version20160128130854 extends AbstractMigration
{
    public static $description = "Migration description";

    public function up()
    {
        //$this->addSql(/*Sql instruction*/);
    }

    public function down()
    {
        //$this->addSql(/*Sql instruction*/);
    }
}

Migrate

Migrate to latest version, <sub>(*5)</sub>

vendor/bin/migration migrate

, <sub>(*6)</sub>

Execute

Execute specific migration version (up or down), <sub>(*7)</sub>

vendor/bin/migration execute version --up --down

, <sub>(*8)</sub>

Options

--dump

If --dump parameter is present, migration will only dump query in screen, <sub>(*9)</sub>

--dsn and --username

If you don't want to create config.php file, you can send --dsn setup parameter. If you send --dsn parameter, you need to send --username parameter too. The prompt will ask your database password., <sub>(*10)</sub>

--dir

Directory where to save migrations classes, default migrations, <sub>(*11)</sub>

--table

Table where to store migrations versioning history, default migrations, <sub>(*12)</sub>

Issues

Please report issues to Github Issue Tracker, <sub>(*13)</sub>