nxnom / erdb

ERDB is a Ruby Gem for generation Entity-Relationship Diagrams (ERD). Currently it support sqlite, mysql and postgresql database.

ERDB

ERDB is a Ruby Gem for generation Entity-Relationship Diagrams (ERD). Currently it support sqlite3, mysql2 and postgresql database. ERDB is just a wrapper to automate the process of generating ERD using -

• Azimutt(Open Source)
• DBDiagram

Demo

Requirements

• Ruby 2.7.0 or higher
• Chrome Browser.

Installation

Use the package manager gem to install ERDB.

gem install erdb

Important note for Linux users: You need to install the xsel or the xclip command-line program. On debian and ubuntu, xsel can be installed with: sudo apt-get install xsel Visit clipboard for more details about clipboard.

Adapters

For mysql2 and postgresql database, you have to install the required gems.

gem install mysql2
gem install pg

Usage

After install ERDB, you can use erdb command to generate ER Diagram.

erdb

It use chrome browser by default to genereate ERD. You can use other browser by passing --browser option.

See more options by running erdb --help

Why I created this gem?

I know there are many tools available for generating ERD, But I wanted to create a tool that is easy to use and can be used with any database. And I don't want to repeat the same steps again and again for generating ERD. -_-

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

This project is licensed under MIT license. View LICENSE for more details.