dsh

A set of command line database tools

go install github.com/yznts/dsh/cmd/...@latest

Main goal of the project is to provide a set of multiplatform tools to work with databases in a unified way, avoiding differences in UX between clients like psql, sqlite3, mysql, etc.

It tries to stick with the UNIX-like naming and approach, where each tool does one thing and does it well. List database tables, or table columns? Just use dls. Get table contents? Use dcat. Or, if you need just to execute an SQL query, dsql is here for you. Want to get the output in JSON, JSONL, CSV? No problem, just specify an according flag, like -json or -csv.

Now, utility set includes:

• dls - lists database tables or table columns
• dsql - executes SQL queries
• dcat - outputs table data (in the not-so-dumb way)
• dps - lists database processes (if supported by the database)
• dkill - kills database processes (if supported by the database)

May be used with:

• sqlite
• postgresql
• mysql (no certificates support yet)

And supports this output formats:

• json (partial support)
• jsonl
• csv
• gloss (default terminal output)

Installation

You have multiple ways to install/use this utility set:

• Install in Go-way
• Build by yourself
• Download binaries
• Spin-up a Docker container

Install in Go-way

This is the easiest way to install, but you need to have Go installed on your machine, including GOBIN in your PATH.

go install github.com/yznts/dsh/cmd/...@latest

Build by yourself

This way still requires Go to be installed on your machine, but it's up to you to decide where to put the binaries.

mkdir -p /tmp/dsh && cd /tmp/dsh
git clone [email protected]:yznts/dsh.git .
make build

# You'll find binaries in the `bin` directory.
# Feel free to move them to the desired location, e.g. /usr/local/bin.

Download binaries

Also you have an option to download the latest binaries from the Releases page. Please note, that darwin(macos) binaries are not signed! If you know a simple way to handle this issue, please open issue or PR.

Spin-up a Docker container

Docker way doesn't require Go to be installed on your machine and it allows you to use the tooling in isolated way, without polluting your system.

docker run --rm -it ghcr.io/yznts/dsh:latest

Usage

No need to copy-paste utilities descriptions here. Most of them you can recognize by their names. Each tool has its own help message, which you can get by running it with -h flag. From there you can understand tool purpose, how to use it and what flags are available.

To avoid providing database connection details each time you run a tool, you can use environment variables.

$ export DSN="postgres://user:password@localhost:5432/dbname"
$ dls # No need to provide -dsn here

DSN composition might be a bit challenging. Here is a general template for it:

[protocol]://[username]:[password]@[host]:[port]/[database]?[params]

Some examples of DSNs for different databases:

# SQLite
# We can use both absolute and relative paths.
sqlite:///abs/path/to/db.sqlite
sqlite3://rel/path/to/db.sqlite

# Postgres
# Postgres DSN is quite straightforward.
postgres://user:password@localhost:5432/dbname
postgresql://user:password@localhost:5432/dbname
postgresql://user:password@localhost:5432/dbname?sslmode=verify-full&sslrootcert=/path/to/ca.pem&sslkey=/path/to/client-key.pem&sslcert=/path/to/client-cert.pem

# MySQL
# Please note, that our MySQL integration doesn't support certificates yet.
# Also, DSN is a bit different from the standard one.
# It doesn't have a protocol part, which wraps the host+port part.
mysql://user:password@localhost:3306/dbname?parseTime=true