Overview

Render Room schemas into ER diagrams.

Once you have a JSON representation of your Room exported schema, you can use FloorPlan to transform it into a DBML or DOT representation, or into SVG and PNG files, to then be checked back into the repository.

Diagram rendering

FloorPlan supports rendering to multiple formats, including SVG vectors, PNG and DOT, via its integration with the GraphViz visualization library.

See an example of Tivi's's schema (v26) when rendered into a SVG file:

Diagram metadata

Some output formats allow for metadata to be attached to the ER diagram rendering. When outputting to SVG, FloorPlan will include supplementary information on entities, if available.

Database Markup Language (DBML).

DBML (Database Markup Language) is an open-source DSL language designed to define and document database schemas and structures. It is designed to be simple, consistent and highly-readable.

FloorPlan provides a translation mechanism from the input database schemas into DBML, that can be later used for other interesting applications, like ER diagram rendering or in as an input for Pull Request revision on a development process.

DBML parser

With a few manual tweaks, DBML can also be used directly as an input to the rendering mechanism, by skipping the pipeline's JSON-consumption step.

dbdiagram

dbdiagram is a free, simple tool to draw ER diagrams, that can be used to render the DBML output of FloorPlan.

For instance, when translating Tivi's schema (v26), this is the rendered output in dbdiagram:

Note

FloorPlan and its developers are in no way associated to dbdiagram.