Database Migrations¶

Package git repository¶

https://github.com/phalcon/migrations

Requirements¶

• PHP >= 7.5
• Phalcon >= 5.0.0

Installing via Composer¶

composer require --dev phalcon/migrations

Quick start¶

What you need for a quick start:

• Configuration file in the root of your project (you can also pass them as parameters inside CLI environment)
• Create database table structure
• Execute command to generate migrations

After that, you can execute that migration (run) in another environment to create the same DB structure.

Create the configuration file¶

<?php

use Phalcon\Config\Config;

return new Config([
    'database'    => [
        'adapter'  => 'mysql',
        'host'     => '127.0.0.1',
        'username' => 'root',
        'password' => '',
        'dbname'   => 'db-name',
        'charset'  => 'utf8',
    ],
    'application' => [
        'logInDb'              => true,
        'migrationsDir'        => 'db/migrations',
        // true - TIMESTAMP, false - versions
        'migrationsTsBased'    => true, 
        'exportDataFromTables' => [
            // Tables names
        ],
    ],
]);

Generate migrations¶

Basic generation

vendor/bin/phalcon-migrations generate

**Generate a specific table and export data from it

vendor/bin/phalcon-migrations generate \
    --config=migrations.php \
    --table=users \
    --exportDataFromTables=users \
    --data=oncreate

Run migrations¶

vendor/bin/phalcon-migrations run

List existing migrations¶

vendor/bin/phalcon-migrations list

Usage example¶

Run migrations from specific migrations directory

<?php

use Phalcon\Migrations\Migrations;

$migration = new Migrations();
$migration::run([
    'migrationsDir' => [
        __DIR__ . '/migrations',
    ],
    'config' => [
        'database' => [
            'adapter' => 'Mysql',
            'host' => 'phalcon-db-mysql',
            'username' => 'root',
            'password' => 'root',
            'dbname' => 'vokuro',
        ],
    ]
]);

Migration methods¶

Each migration is a separate class that works as an entity for a specific database table. Inside each class, different methods can occur during migration running.

Each migration file (and class) can implement specific methods, that will be executed based on the operation requested. There are no restrictions on the logic encapsulated in each method.

The tables below show the Migration Class methods. They are stored by order of execution, earliest to latest.

Running to up

Running to down

CLI Arguments and options¶

Arguments

Options

Timestamp based migrations¶

Using this approach is useful when more than one developer is participating in the database structure management. Use 'migrationsTsBased' => true in the config file or --ts-based option in CLI environment. Also, you need to specify the suffix descr, which could be anything you want, for example: semantic version.

Current command

vendor/bin/phalcon-migrations generate --ts-based --descr=1.0.0

Will produce folder names with such names

* 1582539287636860_1.0.0
* 1682539471102635_1.0.0
* 1782539471102635_1.0.0

Migrations will be executed from oldest to newest.