README.md

schema-to-erd

Generate ERD UML file from Schema DDL file

Installation

$ npm i schema-to-erd

Usage

import { schemaToErd } from 'schema-to-erd';
// or:
const { schemaToErd } = require('schema-to-erd');

schemaToErd('./schema_samples/sakila-schema.sql');

$ schema2erd -s ./schema_samples/sakila-schema.sql
// or:
$ npx schema-to-erd -s ./schema_samples/sakila-schema.sql

Sample Schema files

1. Sakila Sample Database
2. Employees Sample Database - https://github.com/datacharmer/test_db
3. MySQL Sample Database - https://www.mysqltutorial.org/wp-content/uploads/2018/03/mysqlsampledatabase.zip
4. https://github.com/ronaldbradford/schema

Source Codes

Clone

$ git clone https://github.com/youngkiu/schema-to-erd.git
$ git submodule update --init --recursive

Contribute

If an error occurs during use, please open a new issue with the schema.sql file.

Reference for package

• https://youtu.be/ZINPuzq62lE
• https://youtu.be/V_5ImTOmMh0
• https://github.com/joeythelantern/Component-Library