DEV Community πŸ‘©β€πŸ’»πŸ‘¨β€πŸ’»

Sualeh Fatehi
Sualeh Fatehi

Posted on • Updated on

How to Visualize Your PostgreSQL Database with One Command (and Nothing to Install)

Ever wondered what the tables in your PostgreSQL database look like, and how they are related to each other? Generate a diagram of your PostgreSQL database with one command. You can run this on any system that has Docker installed.

On a Linux system, run a command like:

docker run \
--mount type=bind,source="$(pwd)",target=/home/schcrwlr \
--rm -it \
schemacrawler/schemacrawler \
/opt/schemacrawler/bin/schemacrawler.sh \
--server postgresql \
--host castor.db.elephantsql.com \
--user yourusername \
--password yourpassword \
--database yourdatabase \
--info-level standard \
--command schema \
--output-file output.png
Enter fullscreen mode Exit fullscreen mode

The command assumes that you have created a sample database on the excellent ElephantSQL service, including some tables and foreign keys. You will need to obtain the username, password and database name of your ElephantSQL instance. A file called "output.png" will be generated with the database schema, including foreign key relationships.

If you are using PowerShell on Windows, replace the trailing backslash on each line with a back-tick, and map the current directory differently. Run this command:

docker run `
--mount type=bind,source="${PWD}",target=/home/schcrwlr `
--rm -it `
schemacrawler/schemacrawler `
/opt/schemacrawler/bin/schemacrawler.sh `
--server postgresql `
--host castor.db.elephantsql.com `
--user yourusername `
--password yourpassword `
--database yourdatabase `
--info-level standard `
--command schema `
--output-file output.png
Enter fullscreen mode Exit fullscreen mode

You can generate PDF files, and other types of output too. Go through the SchemaCrawler tutorials on Katacoda to learn more SchemaCrawler commands.

Top comments (7)

Collapse
 
adriens profile image
adriens

Go to killercoda.com/schemacrawler for up-to-date Schemacrawler course

Collapse
 
adriens profile image
adriens

Hi @sualeh , would you create a "How to Visualize Your SQLite Database with One Command (and Nothing to Install)" ?... assuming you have an existsing db.sqlite file ?

Collapse
 
sualeh profile image
Sualeh Fatehi

Is "db.sqlite" a binary SQLite database, or a bunch of DDL and SQL statements?

Collapse
 
adriens profile image
adriens

Yup, the binary file ;-p

Thread Thread
 
sualeh profile image
Sualeh Fatehi

You can try the instructions in dev.to/sualeh/how-to-visualize-you...

Thread Thread
 
adriens profile image
adriens

Perfect !

Collapse
 
adriens profile image
adriens

Hi @sualeh : could you please provide us the killercoda version ?

Hey 😍

Want to help the DEV Community feel more like a community?

Head over to the Welcome Thread and greet some new community members!

It only takes a minute of your time, and goes a long way!