dbine: Transform Database Table Definitions into Visual Insights

Overview
dbine is a powerful tool designed to simplify the understanding of database structures. It enables users to extract and visualize database table definitions into well-organized PDF documents and images, making database management more intuitive and accessible.

Concept
dbine aims to provide a user-friendly way to output and visualize database relationships through PDF files that resemble ER diagrams. This approach helps in grasping complex database structures at a glance.

Features

• Effortless Database Connection: Log in to supported databases (MySQL and PostgreSQL) to effortlessly retrieve table definition information.
• Visual Outputs: Generate PDF files from table definitions, which can then be converted into image formats for easy sharing and presentation.
• Intuitive CLI Commands: Utilize simple command-line interface commands to execute tasks such as writing definitions and converting output formats.

Example Usage

1. Prepare your database connection configuration:
   Create a database.yaml file with the following structure:

   Type: MySQL
   DatabaseName: db
   UserName: _user_
   Password: pass
   Host: localhost
   Port: 0
   

2. Generate a PDF of your database table definitions:
   Execute the following command in your CLI:

   dbine pdf.write database.yaml database.pdf
   

3. Convert the generated PDF to an image format:
   Run:

   dbine pdf.convert database.pdf database.png
   

Development Motivation

dbine was developed out of the need to visualize complex database relationships clearly and concisely. By representing database structures in visual formats, users can quickly comprehend the architecture and relationships between tables, enhancing data management workflows.

Supported Database Systems

• PostgreSQL
• MySQL

Summary of Versions

Get started with dbine today for a more insightful approach to managing and visualizing your databases!