Skip to content

Repository files navigation

DB VIZ

This is a wip, it will be a visualization tool for any database when it is done. It will work through the command line and expect you to either ask it for schemas, or a row. With that decision, it will query for the data and all related data, then create an html file that will display that data in a graph format with the relationships highlighted. There will be more features later, but for now, this is what I want for my job, so that's what it is going to be!

The first db will be postgresql, because that is what we currently use at my company. After that, sqllite will be added, then mongodb. Then it will be opened up to the public for any other db that people want to add.

TLDR: ONLY WORKS ON POSTGRES

steps to use:

  1. clone the repo
  2. cd into the repo
  3. type 'go build && go run dbVisualizer.com'

Screenshot 2025-02-12 at 18 39 21

  1. Select the first option (second will come with future pr's)
  2. Fill in the following (With your db data -> reminder, only works with postgresql at the moment):

Screenshot 2025-02-12 at 18 40 14 Screenshot 2025-02-12 at 18 40 26 Screenshot 2025-02-12 at 18 40 36 Screenshot 2025-02-12 at 18 40 45

  1. Wait for the following screen:

Screenshot 2025-02-12 at 18 40 54

  1. Go to: http://localhost:42069/
  2. The following screen should be there

Screenshot 2025-02-12 at 18 37 53

  1. Click on the details to view the data
  2. Nested details are foreign keys, table data is non-foriegn
  3. After 2 layers of nesting, on hover of detail, you get a tooltip that is clickable
  4. Click on the tooltip -> should make that table the new main table

Screenshot 2025-02-12 at 18 45 22

  1. There are now breadcrumbs that are clickable

  2. To go back to the main view click reset, or the left-most breadcrumb

  3. To change tables, enter a new table name in the cli

  4. You might need to reload the page at localhost (bug I am working on)

  5. If you want to view the current subtree in a graph format, click graph

Screenshot 2025-02-15 at 18 56 29

  1. On hover of item it will display the node and subnodes

Screenshot 2025-02-17 at 13 10 38

About

Database visualization cli tool

Resources

Stars

1 star

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages