Automatizando e versionalizando as tabelas do banco de dados com Phinx

O que é Phinx ?

É uma ferramenta para escrever e executar migrations, usada inclusive pelo plugin de migrations do framework CakePHP. Atualmente os frameworks PHP populares possui recurso de migrations incluso, mas caso você esteja em um projeto que não utilize nenhum framework PHP e precisa de uma forma organizada e atualizada de controlar as alterações na base de dados, nesse caso o Phinx pode ajudar.

SGBD suportados
O Phinx suporte aos SGBDs: MySQL, PostgreSQL, SQLite, SQL Server

• MySQL: use mysql adapter.
• PostgreSQL: use pgsql adapter.
• SQLite: use sqlite adapter.
• SQL Server: use sqlsrv adapter.

Instalação do Composer
Para instalar o Phinx, precisa instalar o Composer que pode ser obtido no site https://getcomposer.org/
Windows: Após fazer o download do executável, execute e segue Next, Next e Finish

Linux
Debian:
# apt-get install curl

CentOS:
# yum install curl

Download do Composer
# curl -sS https://getcomposer.org/installer | php
Setar permissão de execução
$ chmod +x composer.phar
Mover para o diretório local
# mv composer.phar /usr/local/bin/composer

Instalação do Phinx
No diretório do projeto, execute
$ composer require robmorgan/phinx

Execute o comando seguinte para gerar o arquivo phinx.yml
$ vendor/bin/phinx init .

O arquivo phinx.yml é onde armazena as informações do banco de dados, vem montado base de produção, desenvolvimento e testes, cabe preencher as credencias do banco de dados.
Na configuração default_database define o ambiente da base default, por boas práticas, coloca-se development como default.

Assim ao executar o migrate não precisa especificar o argumento. Para atualizar a base de testes e produção, faça:
$ vendor/bin/phinx migrate -e testing
$ vendor/bin/phinx migrate -e production

Para cada tabela nova e/ou alterações na tabela já existente deve criar um migrate com o padrão CamelCase.
Estando no diretório onde instalou o phinx, o comando para criar uma migration é: vendor/bin/phinx create NomeDaMigrationCorrespondente
Com isso, irá gerar um arquivo template no diretório db/migrations com o nome da migration incluindo timestamp no nome do arquivo criado. É nesse arquivo que irá criar a tabelas e os campos. Veja o arquivo de exemplo para se basear. Após a implementação do arquivo da migrations correspondente, pode executar o comando para criar a migrations no banco, com o comando vendor/bin/phinx migrate

Tipos das colunas inclusos nas migrations (tabelas)

• biginteger
• integer
• boolean
• date
• datetime
• decimal
• float
• string
• text
• time
• timestamp
• uuid

Criar uma migration para uma tabela correspondente
$ vendor/bin/phinx create NomeDaMigrationCorrespondente
Irá gerar o arquivo correspondente ao nome da migration com timestamp no diretório db/migrations

Implementar a migration criada
Edita o arquivo db/migrations/< TIMESTAMP_nome_migration_criada >.php
Para uma nova tabela, coloca no método up() e no final aplica com o método save().
Para alteração de uma tabela já existente, coloca no método change() e no final aplica com o método update().
Nova tabela
public function up()
{
$nome_tabela = $this->table('nome_tabela');
$nome_tabela->addColumn('nome', 'string', array('limit' => 100))
->addColumn('sobrenome', 'string', array('limit' => 100))
->addColumn('email', 'string', array('limit' => 100))
->addColumn('d_criado', 'datetime')
->addColumn('d_atualizado', 'datetime', array('null' => true))
->save();
}

Alteração na tabela
public function change()
{
$nome_tabela = $this->table('nome_tabela');
$nome_tabela->addColumn('nome_coluna', 'tipo', array('after' => 'nome_coluna'))
->update();
}

Adicionar um FK na tabela
->addForeignkey('id_campo', 'tabela_relacionada', 'id', array('delete'=>'RESTRICT', 'delete'=>'RESTRICT'))


Método down
Esse método faz o oposto do método up() e change(), por exemplo, se up() esta fazendo a criação de uma tabela, no down() faz o drop table, e no change(), no down() faria retornar a alteração anterior. Veja um exemplo claro no item seguinte.
O método down() é executado quando executar o comando de roolback
vendor/bin/phinx rollback

Renomear uma tabela
Após criar a migration
public function up()
{
$nome_tabela = $this->table('nome_tabela');
$table->rename('nome_nova_tabela');
}
public function down()
{
$nome_tabela = $this->table('nome_tabela_nova');
$table->rename('nome_tabela_antiga');
}
Renomear uma coluna da tabela
public function up()
{
$nome_tabela = $this->table('nome_tabela');
$nome_tabela->renameColumn('campo_antigo', 'campo_novo');
}
public function down()
{ $nome_tabela = $this->table('nome_tabela');
$nome_tabela->renameColumn('campo_novo', 'campo_antigo');
}

Executando a(s) migration(s) para criar a(s) tabela(s) correspondente
$ vendor/bin/phinx migrate

Criar Seeds
Vimos a criação do migration que cria e/ou altera tabelas, mas se quisermos popular dados na tabela? É nesse tópico que será visto como fazer.
Criar um seed: vendor/bin/phinx seed:create NomeSeedCorrespondente
Irá gerar o arquivo para o seed correspondente no diretório db/seeds/.php

Exemplo de seed para tabela usuarios
$ vendor/bin/phinx seed:create CriaUsuarioZeferino
public function run()
{
$dados = array(
array('nome' => 'Zeferino',
'prenome' => "",
'sobrenome' => 'Silva',
'apelido' => 'Testador',
'email' => 'zeferino.silva@hotmail.com',
'senha' => '$2a$08$R2Tzm7EugyNcquA7BYIyVetLdji4XFTAhsA1A3M85zt0IUDlQis86',
'cpf' => '61813735786',
'id_usrt' => 1,
'acesso' => 0,
'status' => 1)
);
$user = $this->table("usuarios");
$user->insert($dados)
->save();
}

Executar o seed criado na tabela:
vendor/bin/phinx seed:run -s CriaUsuarioZeferino
Verifique se a(s) tabela(s) foram criadas e/ou populadas no seu BD, se foram, está correto.

Considerações finais

Após utilizar o Phinx no projeto, notou-se no time de desenvolvimento uma organização e automação no deploy na base de dados local garantindo a mesma estrutura das tabelas nos ambientes de desenvolvimento, homologação e produção.
Espera-se que possa ser útil no seu time de desenvolvimento no projeto em PHP também.

Referência
http://docs.phinx.org/en/latest
Feito!