DB Lens is an open-source database client that helps you to explore database, understand data relations more quickly with automatic ER diagrams, visualise and analyse internal DB metrics such as index utilisation sequential scans, slow running queries, storage and many more.

Don't want to install?

Try running

npx dblens <connection_string>
# npx dblens postgres://user:pass@host/db

from your terminal

Features

Note : Some features are not available on the browser version yet.

• Connect with a click: simply connect to a DB by clicking on the connection string 🪄
• Usage Analysis: Understand how the database is beign used across tables
• Performance overview: Understand how frequently table/index are scanned and the slow queries.

Setup dev env

Prerequisites

NodeJS & yarn (NPM should also work but we are maintaining a yarn lock file only

Steps

• install dependencies

yarn install

• to run the application

yarn start

• to build and package the application

yarn package

Branching

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

1. Fork the repo and create your branch from main.
2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the documentation.
4. Ensure the test suite passes.
5. Make sure your code lints.
6. Issue that pull request!