ERDIA

erdia is create ER Diagram and Entity schema specification using by TypeORM and mermiad.js

Why erdia ?

erdia is a cli tool that allows you to automatically generate DB specifications and ER diagram documents using TypeORM. It is very hard to be diligent about updating DB specifications and ER diagrams whenever code and DB changes. erdia automatically generates DB statement and ER diagram documents using information provided by TypeORM whenever the code changes. By automatically generating documents using TypeORM code, you can maintain the freshness of your documents with minimal effort.

Summary,

1. ER diagram generate using mermaid.js syntax.
2. Every document generate using ETA template engine
3. Use TypeORM

Automate your database ER diagram drawing!

Table of Contents <!-- omit in toc -->

• How it works?
• Getting started
  • Installation
  • Confuguration
  • Generation
• Usage
  • Commands
  • CLI Options
• Programming Interfaces
  • Interfaces
  • Function Options
• Requirement
• Example
  • Showcase
  • Documents
• Output Format
• Template
• TypeScript
• License
• References

erdia support initialization command. And you execute build command.

How it works?

graph LR

A[TypeORM Entity] --> erdia
subgraph erdia
direction TB
C[TypeORM Entity]-->|extract <br/>entity specification|B[erdia]
end
erdia-->|extract <br />specification|D
D[ETA<br />template<br />engine]-->E[html]
D-->F[markdown]
D-->G[pdf]
D-->H[image]

Getting started

Installation

npm install erdia --save-dev

Confuguration

npx erdia init

Generation

erdia build -d [your dataSource path] -o dist/entity --format html

Usage

Commands

erdia supports the build, clean, init, and eject commands.

| Command | Description | | ------- | ----------------------------------------------------------- | | build | Builds the erdiagram document. | | init | Generates a configuration file for creating erdiagrams. | | eject | Generates a template document file for creating erdiagrams. | | clean | Deletes the previously built erdiagram document. |

CLI Options

• build options
• init options
• eject options
• clean options

Programming Interfaces

Interfaces

| Command | Description | | ------------ | ----------------------------------------------------------- | | building | Builds the erdiagram document. | | initializing | Generates a configuration file for creating erdiagrams. | | ejecting | Generates a template document file for creating erdiagrams. | | cleaning | Deletes the previously built erdiagram document. |

Function Options

• build options
• init options
• eject options
• clean options

Requirement

• TypeORM 0.3.x

Example

Showcase

Documents

• ER diagram html format
• ER diagram png image format
• ER diagram & table pdf format

Output Format

erdia support html, markdown, pdf, svg, png. Database entity specification table only support html, markdown, pdf format.

# PDF document generate
erdia build -d [your dataSourcePath] -o dist/entity --format pdf

Template

erdia use ETA template for entity specification document and ER diagram. Template easily detach from erdia.

npx erdia eject

Detached template can change and every document customizable. The template can be found here.

TypeScript

If you are using TypeScript, you must use ts-node or tsx to run erdia. This is because the TypeORM Entity file is written in TypeScript.

• ts-node
• tsx
• scripts

License

This software is licensed under the MIT.

References

• TypeORM
• ER Diagram