jawira / doctrine-diagram-bundle
📐 Symfony Bundle to generate database diagrams
Package info
github.com/jawira/doctrine-diagram-bundle
Type:symfony-bundle
pkg:composer/jawira/doctrine-diagram-bundle
Requires
- php: ^8.2
- doctrine/doctrine-bundle: ^2.5 || ^3.0
- doctrine/orm: ^2.9 || ^3.0
- jawira/db-draw: ^2.0
- jawira/doctrine-diagram-contracts: ^2.0
- jawira/entity-draw: ^2.0
- jawira/plantuml-client: ^1.0
- jawira/plantuml-to-image: ^1.1
- symfony/config: ^7.0 || ^8.0
- symfony/console: ^7.0 || ^8.0
- symfony/dependency-injection: ^7.0 || ^8.0
- symfony/filesystem: ^7.0 || ^8.0
- symfony/http-kernel: ^7.0 || ^8.0
Requires (Dev)
- ergebnis/composer-normalize: ^2.42
- friendsofphp/php-cs-fixer: ^3.54
- jawira/plantuml: ^1.2024.4
- jawira/skeleton: ^2.22
- phpstan/extension-installer: ^1.3.1
- phpstan/phpstan: *
- phpstan/phpstan-symfony: *
Suggests
- jawira/plantuml: Install PlantUML executable/jar with Composer.
Provides
None
Conflicts
None
Replaces
None
README
Generate Entity-Relationship and UML class diagrams from a Symfony application's Doctrine schema.
Use the bundle to inspect the current database schema and Doctrine entities. It generates diagrams for monitoring and visualization.
Features
- Generate ER diagrams from a Doctrine DBAL connection and class diagrams from Doctrine entities.
- Choose
mini,midi, ormaxidetail. - Export PlantUML source (
puml) or render diagrams assvgandpng. - Apply built-in PlantUML themes and filter tables or classes with include and exclude patterns.
- Render locally with PlantUML or through a PlantUML server.
Installation
With Symfony Flex, enable community recipes (once per project) and require the bundle as a development dependency:
composer config extra.symfony.allow-contrib true composer require jawira/doctrine-diagram-bundle --dev
Documentation
Read the documentation: https://jawira.github.io/doctrine-diagram-bundle/.
Generate diagrams
# Entity-Relationship diagram bin/console doctrine:diagram:er # UML class diagram bin/console doctrine:diagram:class
By default, the commands write er.svg and class.svg to the project root.
The default format is SVG. Use --format=puml to write PlantUML source without
requiring a renderer, or --format=png for a PNG image.
- See the Generating diagrams guide for connections, entity managers, and output options.
- For themes, filters, and configuration, see Configure the bundle.
Contributing
- Please report bugs and request features.
- If useful, ⭐ star this bundle on GitHub.
License
This library is licensed under the MIT license.
Packages from jawira
-
jawira/plantuml
- Provides PlantUML executable and plantuml.jar
- more...