Download the PHP package egyjs/dbml-to-laravel without Composer

DBML to Laravel Eloquent Generator ✨

Generate Laravel Eloquent models and migration files directly from your DBML (Database Markup Language) diagrams, accelerating Laravel development and streamlining your schema-to-code workflow.

📰 Featured on Laravel News — the official community blog for Laravel developers!

🚀 Motivation

Tired of manually writing Laravel Eloquent models and migration files from your database diagrams? This package automates the process, letting you focus on building features rather than repetitive boilerplate code. Say goodbye to manual schema-to-code conversion and embrace a faster, more efficient Laravel development workflow.

✨ Features

• DBML to Laravel Models: Automatically generate Eloquent models with fillable properties, hidden attributes, and defined relationships (one-to-one, one-to-many, many-to-many).
• DBML to Migration Files: Generate clean and accurate migration files with proper data types, nullability, default values, and foreign key constraints, directly from your DBML schema.
• Customizable Stubs: Easily modify the default model and migration stubs to align with your project's coding style and specific requirements.
• Relationship Parsing: Intelligently parses DBML relationships to create correct Eloquent relationship methods (e.g., hasMany, belongsTo, belongsToMany).
• Casts Support: Automatically adds common Eloquent casts (e.g., JSON to arrays, timestamps to datetime objects) based on DBML column types.
• Incremental Sync: Run dbml:sync to generate alter migrations and patch models based on schema changes — no need to regenerate everything from scratch.

📦 Installation

To get started with the DBML to Laravel Eloquent Generator, follow these simple steps:

1. Require the package via Composer:

2. Publish the customizable stubs (optional, but recommended):

   This command will publish the stub files to stubs/dbml-to-laravel/, allowing you to customize the generated code.

Requirements

• Laravel 8.x+
• PHP 8.0+
• Node.js 18+ runtime (the DBML parser is pre-bundled, so you never need to run npm install in your project)

💡 Usage

Once installed, you can generate your Laravel models and migrations from a DBML file using the dbml:generate Artisan command. (generate:dbml also works as a legacy alias.)

1. Create your DBML schema file (e.g., database/schema.dbml).
   Example database/schema.dbml:

2. Run the Artisan command:

   Replace database/schema.dbml with the actual path to your DBML file.

Expected Output

After running the command, the package will generate:

• Eloquent Models: In your app/Models directory (e.g., app/Models/User.php).
• Migration Files: In your database/migrations directory (e.g., 2023_01_01_000000_create_posts_table.php).

Example Generated app/Models/Post.php:

Example Generated database/migrations/2023_01_01_000000_create_posts_table.php:

Incremental Sync

After your initial generate:dbml, you can iterate on your DBML schema and generate only the changes:

This command:

1. Reads the snapshot (.dbml-sync.json) created by generate:dbml
2. Compares it against the current DBML file
3. Generates alter migrations for added/modified/dropped columns, indexes, and foreign keys
4. Generates create migrations for new tables and drop migrations for removed tables
5. Patches existing Eloquent models within @dbml-sync markers (fillable, casts, relations, table property)

Use --force to skip confirmation prompts:

Workflow example:

Model markers. Generated models include @dbml-sync markers that the patcher targets:

Code outside these markers is never touched by dbml:sync.

⚙️ Customization

You can modify the generated model and migration templates by editing the stub files located in stubs/dbml-to-laravel/ after publishing them. This allows you to tailor the output to your specific project needs, including adding custom traits, interfaces, or modifying default property definitions.

Updating the bundled DBML parser (contributors only)

The published package already includes a fully bundled parser, so consumers never have to install Node dependencies. If you change bin/parse-dbml.js, run the following before opening a PR:

Commit both the updated source file and the generated bin/parse-dbml.runtime.cjs artifact so downstream users continue to benefit from the prepackaged parser.

🤝 Contributing

We welcome contributions! Please see our CONTRIBUTING.md for details on how you can help improve this project. Whether it's bug fixes, new features, or documentation improvements, your input is valuable.

Contributor Documentation

Detailed contributor guides live in the docs/ directory:

❓ Support

For questions, bug reports, or feature requests, please open an issue on the GitHub Issues page. We'll do our best to respond promptly.

🎉 This package was featured by Laravel News. If you find it useful, give it a ⭐ on GitHub and share it with your Laravel team!

📄 License

This project is open-sourced software licensed under the MIT License.