sq/README.md
2020-10-20 09:18:56 -06:00

1.6 KiB

sq: swiss army knife for data

sq is a command line tool that jq-style access to structured data sources such as SQL databases, or document formats such as CSV or Excel. sq can perform cross-source joins, execute database-native SQL, and output to a multitude of formats including JSON, Excel, CSV, HTML, Markdown and XML, or output directly to a SQL database. sq can inspect sources to see metadata about the source structure (tables, columns, size) and has commands for common database operations such as copying or dropping tables.

Usage

See the wiki.

Installation

From source

From the sq project dir:

$ go install

The simple go install does not populate the binary with build info that is output via the sq version command. To do so, use mage.

$ brew install mage
$ mage install

Other installation options

For homebrew, scoop, rpm etc, see the wiki.

Acknowledgements

  • Much inspiration is owed to jq.
  • See go.mod for a list of third-party packages.
  • Additionally, sq incorporates modified versions of:
  • The Sakila example databases were lifted from jOOQ, which in turn owe their heritage to earlier work on Sakila.