cycle/migrations

Database migrations, migration scaffolding

v4.2.4 2024-10-24 17:37 UTC

Requires

• php: >=8.1
• cycle/database: ^2.7.0
• spiral/core: ^3.0
• spiral/files: ^3.0
• spiral/reactor: ^3.0
• spiral/tokenizer: ^3.0

Requires (Dev)

• buggregator/trap: ^1.11
• mockery/mockery: ^1.5
• phpunit/phpunit: ^9.5
• spiral/code-style: ~2.2.0
• vimeo/psalm: ^5.25

MIT

README

Migrations are a convenient way for you to alter your database in a structured and organized manner. This package adds additional functionality for versioning your database schema and easily deploying changes to it. It is a very easy to use and a powerful tool.

Installation

composer require cycle/migrations ^4.0

Configuration

use Cycle\Migrations;
use Cycle\Database;
use Cycle\Database\Config;

$dbal = new Database\DatabaseManager(new Config\DatabaseConfig([
    'default' => 'default',
    'databases' => [
        'default' => [
            'connection' => 'sqlite'
        ]
    ],
    'connections' => [
        'sqlite' => new Config\SQLiteDriverConfig(
            connection: new Config\SQLite\MemoryConnectionConfig(),
            queryCache: true,
        ),
    ]
]));

$config = new Migrations\Config\MigrationConfig([
    'directory' => __DIR__ . '/../migrations/',    // where to store migrations
    'vendorDirectories' => [                       // Where to look for vendor package migrations
        __DIR__ . '/../vendor/vendorName/packageName/migrations/'
    ],
    'table' => 'migrations'                       // database table to store migration status
    'safe' => true                                // When set to true no confirmation will be requested on migration run. 
]);

$migrator = new Migrations\Migrator(
    $config, 
    $dbal, 
    new Migrations\FileRepository($config)
);

// Init migration table
$migrator->configure();

Running

while (($migration = $migrator->run()) !== null) {
    echo 'Migrate ' . $migration->getState()->getName();
}

Generate Migrations

You can automatically generate a set of migration files during schema compilation. In this case, you have the freedom to alter such migrations manually before running them. To achieve that you must install the Schema migrations generator extension.

License:

MIT License (MIT). Please see LICENSE for more information. Maintained by Spiral Scout.