usql

README

About usql

usql is a universal command-line interface for working with SQL databases.

usql provides a universal command-line interface for the following databases: PostgreSQL, MySQL, Oracle, SQLite, and Microsoft SQL Server.

The goal is to eventually have usql be a drop in replacement for PostgreSQL's psql command, with all the bells/whistles, but with the added benefit of working with more than one database.

Releases

Installing

Install in the usual Go way:

# install usql
$ go get -u github.com/knq/usql

# install with oracle support
$ go get -u -tags oracle github.com/knq/usql

Alternatively, you can download a binary release for your platform from the GitHub releases page.

Using

# display command line arguments
$ usql --help

# connect to a postgres database
$ usql pg://user:pass@localhost/dbname
$ usql pgsql://user:pass@localhost/dbname
$ usql postgres://user:pass@localhost:port/dbname

# connect to a mysql database
$ usql my://user:pass@localhost/dbname
$ usql mysql://user:pass@localhost:port/dbname
$ usql /var/run/mysqld/mysqld.sock

# connect to a mssql (Microsoft SQL) database
$ usql ms://user:pass@localhost/dbname
$ usql mssql://user:pass@localhost:port/dbname

# connect to a oracle database
$ usql or://user:pass@localhost/dbname
$ usql oracle://user:pass@localhost:port/dbname

# connect to a sqlite file
$ usql dbname.sqlite3
$ usql sq://path/to/dbname.sqlite3
$ usql sqlite3://path/to/dbname.sqlite3
$ usql file:/path/to/dbname.sqlite3

Example Output

The following is an example of connecting to xo's booktest example Oracle database, performing a query, and then connecting to the PostgreSQL, MySQL, Microsoft SQL Server, and SQLite3 databases and executing various queries.

Related Projects

• dburl - a Go package providing a standard, URL style mechanism for parsing and opening database connection URLs
• xo - a command-line tool to generate Go code from a database schema

TODO

A list of planned / in progress work:

General

• fix mysql "Error 1049:" messages, and better standardize other database error messages
• fix table output
• add support for requesting user enter their password when Open fails with respective driver's authentication error
• add support for managing multiple database connections simultaneously (@conn syntax, and a ~/.usqlconnections file, and ~/.usqlconfig) (maybe not needed, if variable support works "as expected"?)
• SQL completion (WIP)
• syntax highlighting (WIP)
• \encoding and environment/command line options to set encoding of input (to convert to utf-8 before feeding to SQL driver)

Command Processing + psql compatibility

• proper command processing (WIP)
  • variable support / interpolation + \prompt, \set, \unset
• PAGER + EDITOR support
• the \j* commands (WIP)
• \watch
• \errverbose
• formatting settings (\pset, \a, etc)
• all \d* commands from psql (WIP, need to finish work extracting introspection code from xo)
• remaining psql cli parameters

Releases

Need to write scripts for packaging and build binaries for:

• Debian/Ubuntu (.deb)
• MacOS X (.pkg)
• Windows (.msi)
• CentOS/RHEL (.rpm)

Additional:

• Submit upstream to Debian unstable (WIP)

Testing

• full test suite for databases, doing a minimal set of SELECT, INSERT, UPDATE, DELETE

Future Database Support

Notes / thoughts / comments on adding support for various "databases":

• Google Spanner
• SAP HANA (cannot seem to run installer/get it running, support is already in usql, but not tested)
• CockroachDB (uses lib/pq wire protocol)
• ODBC (cross platform issues, similar to oracle with build support)
• Cassandra
• VoltDB
• MemSQL (uses mysql wire protocol)
• Atlassian JIRA JQL (why not? lol)