Laravel Schema Viewer

Schema viewer for Laravel: an interactive diagram of your database tables and Eloquent relationships.

$composer require laranex/laravel-schema-viewer:^1.0@alpha --dev

Get started View on GitHub

Requirements

• PHP ^8.1
• Laravel ^10.36|^11.0|^12.0|^13.0
• MySQL, MariaDB, PostgreSQL, SQLite or SQL Server

Why Laravel Schema Viewer

Laravel has no single schema file. The tables live in the database, and the relationships live in your Eloquent models. Laravel Schema Viewer reads both and draws them together, so anyone on the team can see how the data fits without reading migrations or models.

• Every table, with or without a model. Tables, columns, indexes and foreign keys come straight from the database, framework tables included.
• Every relation your models declare. belongsTo, hasMany, belongsToMany with its pivot, polymorphic relations, through relations, dynamic relations and third-party relation types. Each one is read from the object the method returns, without running a query.
• One line per relationship. A foreign key and the relations that use the same columns become one edge, labeled with the methods and the kind of relationship: one-to-many, many-to-many, polymorphic, has-many-through.
• Hints where the two disagree. Relations without a foreign key, foreign keys without a relation or an index, models without a table.
• Downloads and commands. The database schema as Mermaid, DBML, Markdown or JSON, and a check that fails your CI on the hints you choose.

Open /schema-viewer in your local environment and the diagram is there; nothing to configure.

composer require laranex/laravel-schema-viewer:^1.0@alpha --dev

Alpha

This is the first alpha. The viewer and the commands work, and the configuration may still change before v1.0.0.