artesaos/migrator

Namespaced Migrations for Laravel 5.1+

artesaos/migrator

, _(*1)

This package is a customized version of Laravel's default database migrator, it was designed to register migrations on services providers and support namespacing as well., _(*2)

There is no timestamp previews since the run order is based on how you register the migrations., _(*3)

Warning

This Package Supports Laravel starting on 5.2 up to the latest stable version., _(*4)

Installing

In order to install Migrator, run the following command into your Laravel 5.2+ project:, _(*5)

composer require artesaos/migrator

After installing the Package, you can now register it's provider into your config/app.php file:, _(*6)

'providers' => [
    // other providers omitted.
    Migrator\MigrationServiceProvider::class,
]

And publish configuration: with, _(*7)

php artisan vendor:publish --provider="Migrator\MigrationServiceProvider"

Upgrading from v1.x to v2.0.

On v1.x, this package uses the same table name as the default migration engine., _(*8)

On version v2, there is a separate table used for tracking migrations, and it defaults to: migrator_table, _(*9)

If you are upgrading from v1, you may either rename the migrations table to migrator_table OR publish the config file and set the migrator table name to migrations., _(*10)

Either should work., _(*11)

v2 works alongside default migrations, for projects who want to namespace migrations but already have many migrations in place., _(*12)

Usage

As the default Laravel migrator, this one has all the original commands, to list the available options, you can see all the available options using php artisan command., _(*13)

migrator            Run the database migrations
migrator:fresh      Drop all tables and re-run all migrations
migrator:install    Create the migration repository
migrator:make       Create a new migration file
migrator:refresh    Reset and re-run all migrations
migrator:reset      Rollback all database migrations
migrator:rollback   Rollback the last database migration
migrator:status     Show the status of each migration

Creating Migrations

In order to generate an empty migration, please provide the migrator with the full qualified class name, as the example., _(*14)

php artisan migrator:make 'MyApp\MyModule\Database\Migrations\CreateOrdersTable' --create=orders, _(*15)

This will create a migration class into the right directory, the resulting file is slightly different from the default Laravel generated:, _(*16)

<?php

namespace MyApp\MyModule\Database\Migrations;

use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;

class CreateOrdersTable extends Migration
{
    /**
     * @var \Illuminate\Database\Schema\Builder
     */
    protected $schema;

    /**
     * Migration constructor.
     */
     public function __construct()
     {
         $this->schema = app('db')->connection()->getSchemaBuilder();
     }

    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        $this->schema->create('orders', function (Blueprint $table) {
            $table->increments('id');
            $table->timestamps();
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        $this->schema->drop('orders');
    }
}

To declare your table fields, just follow the usual schema build practices, this package don't make anything different there., _(*17)

As the normal migrator, you can pass the option --table instead of --create in order to generate a update migration instead of a create one. Also, you can create a empty migration not passing any of those options., _(*18)

Registering migrations.

Inside any service provider of your choice (usually on the same namespace that you're storing the migrations), you easily register the migrations using the Migrator\MigratorTrait:, _(*19)

<?php

namespace MyApp\MyModule\Providers;

use Illuminate\Support\ServiceProvider;
use Migrator\MigratorTrait;
use MyApp\MyModule\Database\Migrations\CreateOrdersTable;
use MyApp\MyModule\Database\Migrations\CreateProductsTable;

class MyModuleServiceProvider extends ServiceProvider
{
    use MigratorTrait;

    public function register()
    {
        $this->migrations([
            CreateOrdersTable::class,
            CreateProductsTable::class,
        ]);
    }
}