barney-k/yii2-migration-module

Yii2 module for managing migrations

yii2-migration-module

A module for Yii2 framework to create and manage migration files without CLI, _(*1)

Installation

Two-step installation with composer., _(*2)

This instructions assumes that you have composer installed and db configured for your Yii2 application., _(*3)

Step 1: Download using composer

Add yii2-migration-module to the require section of your composer.json file:, _(*4)

{
    "require": {
        "barney-k/yii2-migration-module": "dev-master"
    }
}

And run following command to download extension using composer:, _(*5)

$ php composer.phar update

OR, _(*6)

$ php composer.phar require barney-k/yii2-migration-module "dev-master"

Step 2: Configure your application

Add migration module to both web config files (or backend config if you're using advanced templating) as follows:, _(*7)

...
'modules' => [
    ...
    'migration' => [
        'class' => 'barneyk\migration\MigrationModule',
    ],
    ...
],
...

Configuration

You can configure the module by adding additional parameters to the config file after the class key:, _(*8)

• admins:
  • this is an array usernames, that can access this module
  • default: []
• migrationPath:
  • path of the migration files
  • default: '@vendor/barney-k/yii2-migration-module/migrations'
• dateFormat:
  • php date format string for displaying the create and apply dates.
  • default: 'Y.m.d. H:i:s'
• migrationTable:
  • name of the database table for the migrations
  • default: 'migration'

Example:

...
'migration' => [
    'class' => 'barneyk\migration\MigrationModule',
    'admins' => ['root','admin','johndoe'],
    'migrationPath' => '@app/migrations',
    'dateFormat' => 'd/m/Y H:i:s',
    'migrationTable' => 'my_migrations',
],
...

Usage:

• Create a new migration file
• Open up the generated file from the migrationPath
• Write your migration code. Guide about migrations
• Save the file
• Click on the migration's name in the migration list
• You can see the interactions that you can do with that migration under the details table

Features:

• Generates migration files without CLI
• Indicates that if it's already applied or not
• Applies only one migration
• Applies more migrations up to a specific one
• Marks a migration as done
• Marks a migration as undone
• Redos a specific migration
• Reverts a specific migration
• Displays messages from the migration process just like the CLI would