README.md

sqlant

Generate PlantUML/Mermaid ER diagram textual description from SQL connection string
Inspired by planter

Why created

I like the idea of planter and I use it in internal confluence documentation with PlantUML plugin for my projects.
But I want to make it better

Installation

Compiled Binary (Linux only)

Download the binary file from releases page

Docker (Compressed size around 6MB)

The Docker image contains the sqlant binary and serves as a wrapper for executing it. link

docker pull kurotych/sqlant:latest

Cargo

cargo install sqlant

Usage

PlantUML

Binary

sqlant postgresql://sqlant_user:sqlant_pswd@localhost/sqlant_db --legend -e

Docker

docker run --network host kurotych/sqlant postgresql://sqlant_user:sqlant_pswd@localhost/sqlant_db 

postgresql://sqlant_user:sqlant_pswd@localhost/sqlant_db -o mermaid

Mermaid