Skip to main content
Deno 2 is finally here 🎉️
Learn more

About

Sqlr is a simple CLI utility that allows you to execute simple queries against your SQL database (currently only Postgres database is supported).

  • ⚡ Don’t wait for your GUI tools to load, when you need to run simple SQL query
  • :lock: Connection encryption for enhanced security (recommended for remote environments)
  • 📜 List your database structure to quickly identify which columns are in specific table
  • 🥑 Present results in compact form, json or tables
  • 📁 Use queries from .sql files and/or save results to .json files
  • :abacus: CI/CD friendly - commands can be executed directly, without interactive prompts

image

Run sqlr for details on available commands. For each command use --help flag for details on additional options and arguments.

Prerequisites

Deno runtime environment https://deno.land

Installation

deno install -f -r --allow-env --allow-net --allow-read --allow-write https://deno.land/x/sqlr/main.js

--allow-write permission is needed only if you are planning to use -o parameter (write results to json file, check sqlr query --help for details)

If your queries are failing due to certificate validation errors (and you trust target server) you can install using following command:

deno install -f -r --unsafely-ignore-certificate-errors --allow-env --allow-net --allow-read --allow-write https://deno.land/x/sqlr/main.js

This means however, that you are no longer protected from MITM attacks for other servers. You can consider introducing sqlr-unsafe sitting next to your main sqlr instance to work with trusted servers with problematic certificates:

deno install -n sqlr-unsafe -f -r --unsafely-ignore-certificate-errors --allow-net --allow-read --allow-write https://deno.land/x/sqlr/main.js

Hints

If you want to disable colors (at least for main log messages), you can use:

NO_COLOR=1 sqlr ...

Contribution

If you want to implement/request new features you are more than welcome to contribute.