Laravel Migrations Generator

https://github.com/kitloong/laravel-migrations-generator
Admin
This tool generates Laravel migrations from an existing database, including tables, columns,...
Tokens:49,581
Snippets:392
Trust Score:8.8
License:MIT
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install via Composer

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/index.md

Recommended installation method using Composer.

```bash
composer require --dev kitloong/laravel-migrations-generator
```

--------------------------------

### Example of --table-filename usage

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/table-filename.md

An example command using the --table-filename option to specify a custom migration filename pattern.

```bash
php artisan migrate:generate --table-filename="[datetime]_create_mysql_[name]_table.php"
```

--------------------------------

### Ignore Specific Tables Example

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/ignore.md

Example command to generate migrations while excluding the 'users' and 'comments' tables.

```bash
php artisan migrate:generate --ignore="users,comments"
```

--------------------------------

### Artisan command usage

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/default-index-names.md

Example of running the migration generator with the --default-index-names flag.

```bash
php artisan migrate:generate --default-index-names
```

--------------------------------

### Example database schema

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/usage.md

The source SQL schema used to generate the migration files.

```sql
CREATE TABLE `users` (
    `id` BIGINT UNSIGNED AUTO_INCREMENT PRIMARY KEY,
    `name` VARCHAR(255) COMMENT 'comment',
    `email` VARCHAR(255) UNIQUE,
    `email_verified_at` TIMESTAMP NULL,
    `password` VARCHAR(255),
    `remember_token` VARCHAR(100),
    `created_at` TIMESTAMP NULL DEFAULT NULL,
    `updated_at` TIMESTAMP NULL DEFAULT NULL
);

CREATE TABLE `comments` (
    `id` BIGINT UNSIGNED AUTO_INCREMENT PRIMARY KEY,
    `user_id` BIGINT UNSIGNED,
    `title` VARCHAR(255),
    `comment` VARCHAR(255) UNIQUE,
    `created_at` TIMESTAMP NULL DEFAULT NULL,
    `updated_at` TIMESTAMP NULL DEFAULT NULL,
    INDEX `comments_user_id_index` (`user_id`),
    CONSTRAINT `comments_user_id_foreign` FOREIGN KEY (`user_id`) REFERENCES `users` (`id`)
);
```

--------------------------------

### Example of generating migrations with --date

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/date.md

This command generates migration files using the specified date string.

```bash
php artisan migrate:generate --date="2024-10-08 12:30:00"
```

--------------------------------

### Example of a squashed migration file

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/squash.md

This is an example of the resulting migration file structure when using the --squash option, containing multiple schema definitions.

```php
<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
    /**
     * Run the migrations.
     */
    public function up(): void
    {
        Schema::create('comments', function (Blueprint $table) {
            $table->bigIncrements('id');
            ...
        });
        
        Schema::create('users', function (Blueprint $table) {
            $table->bigIncrements('id');
            ...
        });
        
        Schema::table('comments', function (Blueprint $table) {
            $table->foreign(['user_id'])->references(['id'])->on('users')->onUpdate('restrict')->onDelete('restrict');
        });
    }

    /**
     * Reverse the migrations.
     */
    public function down(): void
    {
        Schema::table('comments', function (Blueprint $table) {
            $table->dropForeign('comments_user_id_foreign');
        });
        
        Schema::dropIfExists('users');
        
        Schema::dropIfExists('comments');
    }
};
```

--------------------------------

### Using --template-path in Artisan

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/template-path.md

Example command to generate migrations using a custom template directory located at custom/templates.

```bash
php artisan migrate:generate --template-path="custom/templates"
```

--------------------------------

### Generate migrations with collation

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/use-db-collation.md

Example command to generate migrations using the --use-db-collation option.

```bash
php artisan migrate:generate --use-db-collation
```

--------------------------------

### Generate command with --default-fk-names

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/default-fk-names.md

Example command to run the migration generator with the default foreign key naming option.

```bash
php artisan migrate:generate --default-fk-names
```

--------------------------------

### Generate Migrations for a Specific Connection

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/connection.md

Example command to generate migrations for a connection named secondary.

```bash
php artisan migrate:generate --connection="secondary"
```

--------------------------------

### Generate Migrations with Batch Number

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/log-with-batch.md

Example command to generate migrations and log them with batch number 0, followed by the resulting SQL query and output.

```bash
php artisan migrate:generate --log-with-batch=0
```

```sql
SELECT migration FROM `migrations` WHERE batch = 0;

+----------------------------------------------------------+
| migration                                                |
+----------------------------------------------------------+
| 2024_10_08_083231_create_users_table.php                 |
| 2024_10_08_083231_create_comments_table.php              |
| 2024_10_08_083232_add_foreign_keys_to_comments_table.php |
+----------------------------------------------------------+
```

--------------------------------

### Generated Migration Schema for Secondary Connection

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/connection.md

Example of how the generated migration schema looks when using the secondary connection.

```php
// Up
Schema::connection('secondary')->create('users', function (Blueprint $table) {
    $table->bigIncrements('id');
    ...
});

// Down
Schema::connection('secondary')->dropIfExists('users');
```

--------------------------------

### List available options

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/README.md

Run this command to view all available configuration options for the generator.

```bash
php artisan help migrate:generate
```

--------------------------------

### Enable Facades in Lumen

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/index.md

Uncomment the withFacades line in bootstrap/app.php to enable facades in Lumen.

```php
$app->withFacades();
```

--------------------------------

### Migration logging prompt

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/usage.md

The CLI will prompt to log the generated migrations in the migrations table.

```text
Using connection: mysql

Generating migrations for: comments,users

 Do you want to log these migrations in the migrations table? (yes/no) [yes]:
```

--------------------------------

### Generate migrations for all tables

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/README.md

Run this command to generate migration files for all tables in your configured database.

```bash
php artisan migrate:generate
```

--------------------------------

### CLI usage of --path option

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/path.md

The --path option defines the directory for generated migrations. It defaults to database/migrations if not specified.

```bash
-p, --path[=PATH]
```

--------------------------------

### Log With Batch CLI Flag

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/log-with-batch.md

The --log-with-batch option syntax.

```bash
--log-with-batch[=LOG-WITH-BATCH]
```

--------------------------------

### CLI Connection Option Syntax

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/connection.md

The syntax for the --connection option used in the command line.

```bash
-c, --connection[=CONNECTION]
```

--------------------------------

### Usage of --table-filename option

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/table-filename.md

The syntax for the --table-filename option.

```bash
--table-filename[=TABLE-FILENAME]
```

--------------------------------

### Use --squash option

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/squash.md

The --squash option is used to combine all generated migrations into a single file.

```bash
--squash
```

--------------------------------

### Generate migrations for specific tables

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/README.md

Specify a comma-separated list of tables to generate migrations for.

```bash
php artisan migrate:generate --tables="table1,table2,table3,table4,table5"
```

--------------------------------

### Usage of --default-fk-names flag

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/default-fk-names.md

The command line flag used to enable the default naming convention.

```bash
--default-fk-names
```

--------------------------------

### Specify a database connection

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/README.md

Use the --connection flag to target a database connection other than the default one defined in config/database.php.

```bash
php artisan migrate:generate --connection="connection_name"
```

--------------------------------

### List Available Database Connections

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/connection.md

Code to retrieve the names of all configured database connections.

```php
array_keys(config('database.connections'))
```

--------------------------------

### Template Path CLI Option

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/template-path.md

The syntax for the --template-path option used to define the location of custom migration templates.

```bash
-tp, --template-path[=TEMPLATE-PATH]
```

--------------------------------

### Squash migrations into a single file

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/README.md

Use the --squash flag to combine all generated migrations for each table into a single file instead of multiple files.

```bash
php artisan migrate:generate --squash
```

--------------------------------

### Batch number prompt

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/usage.md

After choosing to log migrations, you are prompted to confirm the batch number.

```text
 Next Batch Number is: 1. We recommend using Batch Number 0 so that it becomes the "first" migration. [Default: 0] [0]:
```

--------------------------------

### Tables option syntax

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/tables.md

The syntax for the --tables option used with the migrate:generate command.

```bash
-t, --tables[=TABLES]
```

--------------------------------

### CLI flag --use-db-collation

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/use-db-collation.md

The command line flag used to enable database collation in generated migrations.

```bash
--use-db-collation
```

--------------------------------

### Generate migration with table check

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/with-has-table.md

Run the generator with the --with-has-table option to produce conditional migration code.

```bash
php artisan migrate:generate --with-has-table
```

```php
if (!Schema::hasTable('users')) {
    Schema::create('users', function (Blueprint $table) {
        $table->bigIncrements('id');
        ...
    });
}
```

--------------------------------

### Default database configuration

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/use-db-collation.md

The default configuration file where collation settings are typically defined.

```php
// config/database.php

return [
    'connections' => [
        'mysql' => [
            ...
            'charset' => 'utf8mb4',
            'collation' => 'utf8mb4_unicode_ci',
        ],
    ],
];
```

--------------------------------

### Use --skip-log CLI flag

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/skip-log.md

This flag skips the confirmation prompt and prevents logging the migration generation to the migrations table.

```bash
--skip-log
```

--------------------------------

### Use --with-has-table flag

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/with-has-table.md

The command line flag to enable table existence checking.

```bash
--with-has-table
```

--------------------------------

### Database schema and generated migration

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/default-index-names.md

Shows the transformation from a database index definition to a Laravel Schema migration using the default naming convention.

```sql
CREATE TABLE `comments` (
    ...
    INDEX `user_id_idx` (`user_id`)
);
```

```php
Schema::create('comments', function (Blueprint $table) {
    ...
    $table->index('user_id');
});
```

--------------------------------

### Usage of --date option

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/date.md

The --date option is used to define the base timestamp for generated migration files.

```bash
--date[=DATE]
```

--------------------------------

### Interactive Batch Prompt

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/log-with-batch.md

The default interactive prompt displayed when logging migrations without specifying a batch number.

```bash
Do you want to log these migrations in the migrations table? (yes/no) [yes]:
 > yes

 Next Batch Number is: 11. We recommend using Batch Number 0 so that it becomes the "first" migration. [Default: 0] [0]:
```

--------------------------------

### Generated migration filenames

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/date.md

The resulting migration files created by the command, showing the base timestamp and the incremented timestamp for foreign keys.

```bash
2024_10_08_123000_create_comments_table.php
2024_10_08_123000_create_users_table.php
2024_10_08_123001_add_foreign_keys_to_comments_table.php
```

--------------------------------

### Generate migrations to a custom path

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/path.md

This command generates migration files into the specified custom/migrations directory.

```bash
php artisan migrate:generate --path="custom/migrations"
```

--------------------------------

### Use --skip-foreign-keys CLI flag

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/skip-foreign-keys.md

Excludes foreign key migrations from the generated migrations.

```bash
--skip-foreign-keys
```

--------------------------------

### Use --skip-vendor CLI flag

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/skip-vendor.md

Prevents the generated migrations from including tables created by vendor packages such as Nova.

```bash
--skip-vendor
```

--------------------------------

### Register Service Provider in Lumen

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/index.md

Add the MigrationsGeneratorServiceProvider to the Register Service Providers section in bootstrap/app.php.

```php
$app->register(\KitLoong\MigrationsGenerator\MigrationsGeneratorServiceProvider::class);
```

--------------------------------

### Database schema and generated migration output

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/default-fk-names.md

Shows the input SQL schema with a custom foreign key name and the resulting Laravel migration code using the default naming convention.

```sql
CREATE TABLE `comments` (
    ...
    CONSTRAINT `user_id_fk` FOREIGN KEY (`user_id`) REFERENCES `users` (`id`)
);
```

```php
Schema::table('comments', function (Blueprint $table) {
    ...
    $table->foreign('user_id')->references('id')->on('users');
});
```

--------------------------------

### Generated migration filenames

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/table-filename.md

The resulting migration filenames after applying the custom --table-filename pattern.

```text
2024_10_08_083231_create_mysql_comments_table.php
2024_10_08_083231_create_mysql_users_table.php
```

--------------------------------

### Ignore Option Syntax

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/ignore.md

The command-line syntax for the ignore option.

```bash
-i, --ignore[=IGNORE]
```

--------------------------------

### CLI flag --default-index-names

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/default-index-names.md

The flag used to enable Laravel's default naming convention for indexes.

```bash
--default-index-names
```

--------------------------------

### Use --skip-proc CLI flag

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/skip-proc.md

Excludes stored procedures from the generated migrations when running the generator command.

```bash
--skip-proc
```

--------------------------------

### Generated migration schema

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/options/use-db-collation.md

The resulting migration code showing the collation and charset settings applied.

```php
Schema::create('users', function (Blueprint $table) {
    $table->collation = 'utf8mb4_unicode_ci';
    $table->charset = 'utf8mb4';

    $table->bigIncrements('id');
    ...
});
```

--------------------------------

### Ignore specific tables

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/README.md

Exclude specific tables from the migration generation process using a comma-separated list.

```bash
php artisan migrate:generate --ignore="table3,table4,table5"
```

--------------------------------

### Generated users table migration

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/usage.md

The migration file generated for the users table.

```php
<?php

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

return new class extends Migration
{
    /**
     * Run the migrations.
     */
    public function up(): void
    {
        Schema::create('users', function (Blueprint $table) {
            $table->bigIncrements('id');
            $table->string('name')->comment('comment');
            $table->string('email')->unique();
            $table->timestamp('email_verified_at')->nullable();
            $table->string('password');
            $table->rememberToken();
            $table->timestamps();
        });
    }

    /**
     * Reverse the migrations.
     */
    public function down(): void
    {
        Schema::dropIfExists('users');
    }
};
```

--------------------------------

### Generated comments table migration

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/usage.md

The migration file generated for the comments table.

```php
<?php

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

return new class extends Migration
{
    /**
     * Run the migrations.
     */
    public function up(): void
    {
        Schema::create('comments', function (Blueprint $table) {
            $table->bigIncrements('id');
            $table->unsignedBigInteger('user_id')->index();
            $table->string('title');
            $table->string('comment')->unique();
            $table->timestamps();
        });
    }

    /**
     * Reverse the migrations.
     */
    public function down(): void
    {
        Schema::dropIfExists('comments');
    }
};
```

--------------------------------

### Generated foreign keys migration

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/usage.md

The migration file generated for foreign keys, which is always created last.

```php
<?php

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

return new class extends Migration
{
    /**
     * Run the migrations.
     */
    public function up(): void
    {
        Schema::table('comments', function (Blueprint $table) {
            $table->foreign(['user_id'])->references(['id'])->on('users')->onUpdate('restrict')->onDelete('restrict');
        });
    }

    /**
     * Reverse the migrations.
     */
    public function down(): void
    {
        Schema::table('comments', function (Blueprint $table) {
            $table->dropForeign('comments_user_id_foreign');
        });
    }
};
```

--------------------------------

### Generated migration for user-defined type column

Source: https://github.com/kitloong/laravel-migrations-generator/blob/7.x/docs/udt-columns.md

Shows the migration generated for a table with a user-defined type column. The column is added via DB::statement after the table creation, and it is always placed at the end of the table.

```php
public function up()
{
    Schema::create('table', function (Blueprint $table) {
        ...
    });
    DB::statement("ALTER TABLE table ADD column custom_type NOT NULL");
}
```
Tokens:
Raw