kitloong/laravel-migrations-generator

Generates Laravel Migrations from an existing database

Fund package maintenance!
kitloong
Buy Me A Coffee

Installs: 5 174 408

Dependents: 24

Suggesters: 1

Security: 0

Stars: 2 616

Watchers: 42

Forks: 287

Open Issues: 2


README

Style check CI Tests CI codecov Latest Stable Version Total Downloads License

Generate Laravel Migrations from an existing database, including indexes and foreign keys!

Documentation

Checkout the documentation for more details.

Supported Database

Laravel Migrations Generator supports all five Laravel first-party support databases:

  • MariaDB
  • MySQL
  • PostgreSQL
  • SQL Server
  • SQLite

Install

The recommended way to install this is through composer:

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

Laravel Setup

Laravel will automatically register service provider for you.

Lumen Setup

Expand

Auto-discovery is not available in Lumen, you need some modification on bootstrap/app.php.

Enable Facade

Uncomment the following line.

$app->withFacades();

Register Provider

Add following line into the Register Service Providers section.

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

Usage

To generate migrations from a database, you need to have your database setup in Laravel's config (config/database.php).

To create migrations for all the tables, run:

php artisan migrate:generate

You can specify the tables you wish to generate using:

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

You can also ignore tables with:

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

Laravel Migrations Generator will first generate all the tables, columns and indexes, and afterward setup all the foreign key constraints.

So make sure you include all the tables listed in the foreign keys so that they are present when the foreign keys are created.

You can also specify the connection name if you are not using your default connection with:

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

Squash Migrations

By default, Generator will generate multiple migration files for each table.

You can squash all migrations into a single file with:

php artisan migrate:generate --squash

Options

Run php artisan help migrate:generate for a list of options.

Options Description
-c, --connection[=CONNECTION] The database connection to use
-t, --tables[=TABLES] A list of tables or views you wish to generate migrations for separated by a comma: users,posts,comments
-i, --ignore[=IGNORE] A list of tables or views you wish to ignore, separated by a comma: users,posts,comments
-p, --path[=PATH] Where should the file be created?
-tp, --template-path[=TEMPLATE-PATH] The location of the template for this generator
--date[=DATE] Migrations will be created with specified date. Views and foreign keys will be created with + 1 second. Date should be in format supported by Carbon::parse
--table-filename[=TABLE-FILENAME] Define table migration filename, default pattern: [datetime]\_create_[name]_table.php
--view-filename[=VIEW-FILENAME] Define view migration filename, default pattern: [datetime]\_create_[name]_view.php
--proc-filename[=PROC-FILENAME] Define stored procedure filename, default pattern: [datetime]\_create_[name]_proc.php
--fk-filename[=FK-FILENAME] Define foreign key migration filename, default pattern: [datetime]\_add_foreign_keys_to_[name]_table.php
--log-with-batch[=LOG-WITH-BATCH] Log migrations with given batch number. We recommend using batch number 0 so that it becomes the first migration
--default-index-names Don't use DB index names for migrations
--default-fk-names Don't use DB foreign key names for migrations
--use-db-collation Generate migrations with existing DB collation
--skip-log Don't log into migrations table
--skip-vendor Don't generate vendor migrations
--skip-views Don't generate views
--skip-proc Don't generate stored procedures
--squash Generate all migrations into a single file
--with-has-table Check for the existence of a table using hasTable

Thank You

Thanks to Bernhard Breytenbach for his great work. This package is based on https://github.com/Xethron/migrations-generator.

Our Amazing Sponsor 🎉

A huge thank you to our sponsor for supporting this project!

Vemto

Want to support this project? Become a sponsor today!

Contributors

Contributors

License

The Laravel Migrations Generator is open-sourced software licensed under the MIT license