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,
- ER diagram generate using mermaid.js syntax.
- Every document generate using ETA template engine
- Use TypeORM
Automate your database ER diagram drawing!
Table of Contents
- How it works?
- Getting started
- Usage
- Programming Interfaces
- Requirement
- Example
- 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-devConfuguration
npx erdia initGeneration
erdia build -d [your dataSource path] -o dist/entity --format htmlUsage
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
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 pdfTemplate
erdia use ETA template for entity specification document and ER diagram. Template easily detach from erdia.
npx erdia ejectDetached 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.
License
This software is licensed under the MIT.