Ecto.ERD

A mix task for generating an ERD (Entity-Relationship Diagram) in various formats for all Ecto schemas in your project.

Supported formats:

DOT (default)
PlantUML
DBML
QuickDBD
Mermaid
D2

Example

DOT

Default DOT entity-relationship diagram

D2 output

Default D2 entity-relationship diagram

PlantUML output

Default PlantUML entity-relationship diagram

All diagrams are generated from the repository's sample schemas.

Installation

The package can be installed by adding ecto_erd to your list of dependencies in mix.exs:

def deps do
  [
    {:ecto_erd, "~> 0.8", only: :dev}
  ]
end

Usage

Just run:

mix ecto.gen.erd

The command above produces a DOT file, which you can convert to an image using the Graphviz utility:

dot -Tpng ecto_erd.dot -o erd.png

Configuration is possible via the .ecto_erd.exs file. The docs can be found at https://hexdocs.pm/ecto_erd. Configuration examples and sample output can be found on the Examples page.