lulco/phoenix

Database Migrations for PHP

Wednesday, July 11, 2018
by lulco
Repository
6 Watchers
49 Stars
16,037 Installations

PHP
1 Dependents
0 Suggesters
2 Forks
5 Open issues
30 Versions
10 % Grown

The README.md

Phoenix

Framework agnostic database migrations for PHP., _(*1)

, _(*2)

Features

Comprehensive Validation: Validate all settings in your migrations before executing the first query, ensuring error-free operations.
Multiple Directories: Manage multiple migration directories with ease, enhancing organizational capabilities.
View Support: Full support for database views, extending the flexibility of your migrations.
Bidirectional Migrations: Seamlessly migrate both up and down, allowing for smooth transitions and rollbacks.
Query Debugging: Print executed queries in debug mode (-vvv), providing transparency and aiding in troubleshooting.
Dry Run Mode: Execute migrations in a dry run mode to preview changes without making any actual modifications, ensuring safe deployments.
Auto-Increment Columns: Effortlessly add an autoincrement primary column to an existing table, simplifying schema modifications.
Database Dump: Use the dump command to create migrations from an existing database, facilitating easy migration setup.
Database Diffing: Generate diff migrations between two existing databases, making it simple to synchronize changes.
Migration Testing: Test new migrations with commands that execute, rollback, and re-execute migrations, ensuring reliability before deployment.
Migration Status: View a detailed status report of executed and pending migrations, keeping track of your migration history.
JSON Output: Get outputs in JSON format for all commands, enabling easy integration with other tools and workflows.
Namespace Support: Use namespaces in migration classes for better organization and code management.
Custom Templates: Create and use your own migration templates, tailoring the process to fit your specific needs.
Framework Agnostic: Easily integrate with any PHP application, offering a seamless migration experience.
Enhanced PHPStorm Integration: Enjoy PHPStorm suggestions, with enhanced support when using the deep-assoc-completion plugin.
Collation Management: Change collation for all existing tables and columns, providing full control over character set settings.
Foreign Key Control: Toggle foreign key checks on and off within migrations, offering flexibility during complex schema changes.
Simple Autowiring: Benefit from simple autowiring in migrations, reducing boilerplate code and enhancing productivity.

Supported adapters

MySQL
PostgreSQL

Installation

Composer

This library requires PHP 7.4 or later. It works also on PHP 8.0+. The fastest and recommended way to install Phoenix is to add it to your project using Composer (https://getcomposer.org/)., _(*3)

composer require lulco/phoenix

Usage

Create configuration file

Create file phoenix.php in the root directory of your project. For example:, _(*4)

<?php

return [
    'migration_dirs' => [
        'first' => __DIR__ . '/../first_dir',
        'second' => __DIR__ . '/../second_dir',
    ],
    'environments' => [
        'local' => [
            'adapter' => 'mysql',
            'host' => 'localhost',
            'port' => 3306, // optional
            'username' => 'user',
            'password' => 'pass',
            'db_name' => 'my_db',
            'charset' => 'utf8mb4',
            'collation' => 'utf8mb4_general_ci', // optional, if not set default collation for utf8mb4 is used
        ],
        'production' => [
            'adapter' => 'mysql',
            'host' => 'production_host',
            'port' => 3306, // optional
            'username' => 'user',
            'password' => 'pass',
            'db_name' => 'my_production_db',
            'charset' => 'utf8mb4',
            'collation' => 'utf8mb4_general_ci', // optional, if not set default collation for utf8mb4 is used
        ],
    ],
    'default_environment' => 'local',
    'log_table_name' => 'phoenix_log',
];

Read more about configuration here., _(*5)

REMEMBER: migrations do some structure changes to the database, therefore the database user used for these migrations has to be able to do these changes., _(*6)

Commands

To run commands, use command runner vendor/bin/phoenix or vendor/lulco/phoenix/bin/phoenix., _(*7)

Available commands:

init - initialize phoenix
create - create migration
migrate - run migrations
rollback - rollback migrations
dump - create migration from existing database
diff - create migration as diff of two existing database structures
status - list of migrations already executed and list of migrations to execute
test - test next migration by executing migrate, rollback, migrate for it
cleanup - rollback all migrations and delete log table

You can run each command with --help option to get more information about it or read more here, _(*8)

Command php vendor/bin/phoenix init initializes phoenix and creates database table where executed migrations will be stored in. This command is executed automatically with first run of other commands, so you don't have to run it manually., _(*9)

Create first migration

Create command php vendor/bin/phoenix create <migration> [<dir>], _(*10)

php vendor/bin/phoenix create "FirstDir\MyFirstMigration" second

This will create PHP class FirstDir\MyFirstMigration in file named {timestamp}_my_first_migration.php where {timestamp} represents actual timestamp in format YmdHis e.g. 20160919082117. This file will be created in migration directory second which is configured as __DIR__ . '/../second_dir' (see configuration example above)., _(*11)

create command creates a skeleton of migration file, which looks like this:, _(*12)

<?php

namespace FirstDir;

use Phoenix\Migration\AbstractMigration;

class MyFirstMigration extends AbstractMigration
{
    protected function up(): void
    {

    }

    protected function down(): void
    {

    }
}

Now you need to implement both methods: up(), which is used when command migrate is executed and down(), which is used when command rollback is executed. In general: if you create table in up() method, you have to drop this table in down() method and vice versa., _(*13)

Let say you need to execute this query:, _(*14)

CREATE TABLE `first_table` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `title` varchar(255) NOT NULL,
  `url` varchar(255) NOT NULL,
  `sorting` int(11) NOT NULL,
  `created_at` datetime NOT NULL,
  PRIMARY KEY (`id`),
  UNIQUE KEY `idx_first_table_url` (`url`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

You need to implement up() method in your migration class as below:, _(*15)

<?php

namespace FirstDir;

use Phoenix\Database\Element\Index;
use Phoenix\Migration\AbstractMigration;

class MyFirstMigration extends AbstractMigration
{
    protected function up(): void
    {
        $this->table('first_table')
            ->addColumn('title', 'string')
            ->addColumn('url', 'string')
            ->addColumn('sorting', 'integer')
            ->addColumn('created_at', 'datetime')
            ->addIndex('url', Index::TYPE_UNIQUE)
            ->create();
    }
}

Or you can use raw sql:, _(*16)

<?php

namespace FirstDir;

use Phoenix\Migration\AbstractMigration;

class MyFirstMigration extends AbstractMigration
{
    protected function up(): void
    {
        $this->execute('CREATE TABLE `first_table` (
                `id` int(11) NOT NULL AUTO_INCREMENT,
                `title` varchar(255) NOT NULL,
                `url` varchar(255) NOT NULL,
                `sorting` int(11) NOT NULL,
                `created_at` datetime NOT NULL,
                PRIMARY KEY (`id`),
                UNIQUE KEY `idx_first_table_url` (`url`)
            ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;'
        );
    }
}

Implementation of correspondent down() method which drops table first_table looks like below:, _(*17)

    protected function down(): void
    {
        $this->table('first_table')
            ->drop();
    }

Now you can run migrate command to execute your first migration., _(*18)

Migrate command

Migrate command php vendor/bin/phoenix migrate executes all available migrations. In this case you will see output like this:, _(*19)

php vendor/bin/phoenix migrate

Migration FirstDir\MyFirstMigration executing
Migration FirstDir\MyFirstMigration executed. Took 0.0308s

All done. Took 0.0786s

If you run this command again, there will be no migrations to execute, so the output looks like this:, _(*20)

php vendor/bin/phoenix migrate

Nothing to migrate

All done. Took 0.0451s

If you want to rollback changes (e.g. you found out that you forgot add some column or index), you can run rollback command, update migration and then run migrate command again. Keep in mind that the best practice is to run rollback command before updating migration code., _(*21)

Rollback command

Rollback command php vendor/bin/phoenix rollback rollbacks last executed migration. In this case you will see output like this:, _(*22)

php vendor/bin/phoenix rollback

Rollback for migration FirstDir\MyFirstMigration executing
Rollback for migration FirstDir\MyFirstMigration executed. Took 0.0108s

All done. Took 0.0594s

If you run this command again, there will be no migrations to rollback, so the output looks like this:, _(*23)

php vendor/bin/phoenix rollback

Nothing to rollback

All done. Took 0.0401s

Dump Command

The php vendor/bin/phoenix dump command generates a migration file from your current database structure, making it easy to start using Phoenix with existing tables. It’s particularly useful for transitioning between MySQL and PostgreSQL., _(*24)

Key benefits: - Quickly create migration files from existing databases. - Simplify Phoenix onboarding. - Facilitate database engine transitions., _(*25)

For detailed usage, see the Dump Command documentation and our guide on switching databases., _(*26)

Diff Command

The php vendor/bin/phoenix diff command generates a migration by comparing two existing database structures. This is ideal for system upgrades where you have both the old and new version schemas., _(*27)

For detailed usage, see the Diff Command documentation., _(*28)

Status command

Run php vendor/bin/phoenix status and show list of migrations already executed and list of migrations to execute. Output is like this:, _(*29)

Executed migrations
+--------------------+---------------------------------------------+---------------------+
| Migration datetime | Class name                                  | Executed at         |
+--------------------+---------------------------------------------+---------------------+
| 20160919082117     | FirstDir\MyFirstMigration                   | 2016-09-26 06:49:49 |
+--------------------+---------------------------------------------+---------------------+

Migrations to execute
+--------------------+---------------------------------+
| Migration datetime | Class name                      |
+--------------------+---------------------------------+
| 20160921183201     | FirstDir\MySecondMigration      |
+--------------------+---------------------------------+

All done. Took 0.2016s

Cleanup command

Cleanup command php vendor/bin/phoenix cleanup rollbacks all executed migrations and delete log table. After executing this command, the application is in state as before executing init command., _(*30)

php bin/phoenix cleanup

Rollback for migration FirstDir\MyFirstMigration executed

Phoenix cleaned

Test command

Test command php vendor/bin/phoenix test executes first next migration, then run rollback and migrate first migration again. This command is shortcut for executing commands:, _(*31)

php bin/phoenix migrate --first
php bin/phoenix rollback
php bin/phoenix migrate --first

Output looks like this:, _(*32)

php bin/phoenix test
Test started...

Migration FirstDir\MyFirstMigration executing...
Migration FirstDir\MyFirstMigration executed. Took 0.0456s

Rollback for migration FirstDir\MyFirstMigration executing...
Rollback for migration FirstDir\MyFirstMigration executed. Took 0.0105s

Migration FirstDir\MyFirstMigration executing...
Migration FirstDir\MyFirstMigration executed. Took 0.0378s

Test finished successfully

All done. Took 0.2840s

The Versions

11/07 2018

dev-master

9999999-dev

Database Migrations for PHP

library phoenix

Database Migrations for PHP

lulco/phoenix

The README.md

Phoenix

Features

Supported adapters

Installation

Composer

Usage

Available commands:

The Versions

dev-master

The Requires

The Development Requires

dev-fix-phpstan

The Requires

The Development Requires

1.0.0

The Requires

The Development Requires

1.0.0.x-dev

The Requires

The Development Requires

dev-add-non-autoincrement-primary-to-existing-table

The Requires

The Development Requires

0.13.0

The Requires

The Development Requires

dev-add-primary-to-existing-table

The Requires

The Development Requires

0.12.1

The Requires

The Development Requires

0.12.0

The Requires

The Development Requires

dev-min-php-7.1

The Requires

The Development Requires

0.11.0

The Requires

The Development Requires

0.10.0

The Requires

The Development Requires

dev-column_comment

The Requires

The Development Requires

0.9.1

The Requires

The Development Requires

0.9.0

The Requires

The Development Requires

dev-strict

The Requires

The Development Requires

0.8.0

The Requires

The Development Requires

0.7.0

The Requires

The Development Requires

0.7.0.x-dev

The Requires

The Development Requires

dev-dump_command

The Requires

The Development Requires

0.6.1

The Requires

The Development Requires

0.6.0

The Requires

The Development Requires

0.5.0

The Requires