zuqongtech/laravel-db-introspection

A Laravel package for automatic database introspection and model generation supporting MySQL, PostgreSQL, SQL Server, and more.

1.0.1 2025-11-12 12:38 UTC

Requires

• php: ^8.2
• illuminate/console: ^10.0|^11.0
• illuminate/database: ^10.0|^11.0
• illuminate/filesystem: ^10.0|^11.0
• illuminate/support: ^10.0|^11.0

Requires (Dev)

• orchestra/testbench: ^8.0
• phpunit/phpunit: ^10.0

MIT

• Gideon Zozingao

README

Zuqongtech/Laravel-DB-Introspection — a Laravel package for automatic database introspection, model discovery, constraint analysis, and Eloquent model generation.

It scans your connected database, analyzes schema metadata, and automatically generates robust Eloquent models — complete with relationships, indexes, PHPDoc, and constraints.

Perfect for teams working with enterprise databases, existing legacy schemas, or large systems that need instant, accurate Eloquent models.

🧠 Features

Core Features

✔ Multi-database engine support ✔ Auto-generates Eloquent models ✔ Relationship detection (FK-based) ✔ Inverse relationships (optional) ✔ Constraint & index analysis ✔ Optional validation of keys and schema integrity ✔ Full PHPDoc generation for IDEs ✔ Dry-run preview mode ✔ Backups of existing models ✔ Highly configurable paths, namespaces & filters

🚀 Installation

composer require zuqongtech/laravel-db-introspection

For local package development:

git clone https://github.com/zuqongtech/laravel-db-introspection.git
cd laravel-db-introspection
composer install

⚙️ Configuration

Publish the config file:

php artisan vendor:publish --provider="Zuqongtech\LaravelDbIntrospection\LaravelDbIntrospectionServiceProvider" --tag=config

Generated file:

config/zt-introspection.php

Basic config:

return [
    'output_path' => app_path('Models'),
    'namespace'   => 'App\\Models',
    'ignore_tables' => [],
];

🧭 Usage

Run the command:

php artisan zt:generate-models

🔧 All Available Flags (Full Documentation)

Below is the full documentation of all flags from the command signature:

🎯 Model Generation Flags

Flag	Description	Example
--force	Overwrite existing models	--force
--backup	Backup existing models before overwriting	--backup
--dry-run	Preview actions without writing files	--dry-run
--namespace=	Set the namespace of generated models	--namespace="App\\Domain\\Models"
--path=	Base folder for generated models	--path=modules/Core

🎛 Table Selection & Filtering

Flag	Description	Example
--tables=*	Only generate models for specific tables	--tables=users --tables=orders
--ignore=*	Skip listed tables	--ignore=migrations
--connection=	Specify database connection	--connection=pgsql

📚 Documentation & Metadata Flags

Flag	Description	Example
--with-phpdoc	Include PHPDoc blocks for IDE autocomplete	--with-phpdoc
--with-constraints	Include constraints in model comments	--with-constraints

🔗 Relationship Flags

Flag	Description	Example
--with-inverse	Generate inverse relations (hasMany, hasOne)	--with-inverse
--validate-fk	Validate all foreign key references	--validate-fk

🧱 Constraint & Integrity Analysis

Flag	Description	Example
--analyze-constraints	Display constraint summary (PKs, FKs, indexes)	--analyze-constraints
--validate-fk	Validate FK integrity across tables	--validate-fk
--show-recommendations	Show optimization suggestions	--show-recommendations

🔥 Combined Example Commands

Generate everything with PHPDoc + inverse relationships:

php artisan zt:generate-models --with-phpdoc --with-inverse

Only generate the users and orders models:

php artisan zt:generate-models --tables=users --tables=orders

Validate foreign keys + analyze constraints:

php artisan zt:generate-models --validate-fk --analyze-constraints

Full analysis + recommendations:

php artisan zt:generate-models --analyze-constraints --show-recommendations

Run without creating any files (dry-run):

php artisan zt:generate-models --dry-run

📂 Example Output

Generated files:

app/Models/User.php
app/Models/Order.php
app/Models/Product.php

Each contains:

• $table
• $fillable
• $primaryKey or composite keys
• Soft delete detection
• Timestamp detection
• Relationships (FK + inverse)
• Optional PHPDoc
• Optional constraint notes

💡 Example Generated Model

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Orders extends Model
{
    protected $table = 'orders';

    protected $fillable = [
        'id',
        'user_id',
        'product_id',
        'status',
        'created_at',
        'updated_at',
    ];

    public function user()
    {
        return $this->belongsTo(User::class);
    }
}

🧰 Development

git clone https://github.com/zuqongtech/laravel-db-introspection.git
cd laravel-db-introspection
composer install

PRs with tests and clean commit history are appreciated.

🧩 Requirements

• PHP 8.2+
• Laravel 10.x or 11.x
• Composer 2.x

🪄 Credits

Developed and maintained by Zuqongtech © 2025 Gideon Zozingao.

🤝 Contributing & Bug Reports

Issues and PRs are welcome!

👉 GitHub: https://github.com/gideonzozingao/laravel-db-introspection