mix ecto.gen.erd (Ecto ERD v0.2.0) View Source
A mix task to generate an ERD (Entity Relationship Diagram) in a DOT/DBML format
DOT
DOT format is able to represent all available entities:
- schemas
- embedded schemas
- schemaless tables (automatically derived from many-to-many relations)
You should have installed graphviz in order to convert *.dot
file to image.
$ mix ecto.gen.erd # generates ecto_erd.dot
$ mix ecto.gen.erd --output-path=ecto_erd.dot
$ mix ecto.gen.erd && dot -Tpng ecto_erd.dot -o erd.png && xdg-open erd.png
See configuration examples and output in EXAMPLES group of PAGES section.
DBML
DBML format is more limited in number of displayed entities comparing to DOT, as it is focused on tables only. Multiple schemas that use the same table are merged into one table. Embedded schemas, obviously, cannot be displayed at all.
This format is very handy if you use dbdiagram.io.
$ mix ecto.gen.erd --output-path=ecto_erd.dbml
See configuration examples and output in EXAMPLES group of PAGES section.
Command line options
--output-path
- the path to the output file, defaults toecto_erd.dot
. File format must be eitherdot
ordbml
.--config-path
- the path to the config file, defaults to.ecto_erd.exs
.
The configuration file
When running a mix ecto.gen.erd
task, it tries to read a configuration file from the .ecto_erd.exs
file in a current
working directory. Configuration file must return a keyword list.
Options
:fontname
- font name, defaults toRoboto Mono
. Must be monospaced font if more than 1 column is displayed. The option is only supported fordot
files.:columns
- list of columns which will be displayed for each node (schema/source). Set to[]
to hide fields completelly. Available columns::name
and:type
. Defaults to[:name, :type]
. The option is only supported fordot
files.:map_node
- function which allows to remove the node from the diagram or to move the node to the cluster. Defaults toFunction.identity/1
, which means that all nodes should be displayed and all of them are outside any cluster. UseEcto.ERD.Node.set_cluster/2
in this function to set a cluster. In order to remove the node, the function must returnnil
.:otp_app
- an application which will be scanned alongside with dependent applications in order to get a list of Ecto schemas. Defaults toMix.Project.config()[:app]
. You need to configure this option only if you run a task from the umbrella root.
Default values can be represented as follows:
# .ecto_erd.exs
[
fontname: "Roboto Mono", # ignored if dbml format is specified
columns: [:name, :type], # ignored if dbml format is specified
map_node: &Function.identity/1,
otp_app: Mix.Project.config()[:app]
]