Command line

Install

macOS / Linux (Homebrew):

brew install LalitMaganti/tap/syntaqlite

macOS / Linux (shell installer):

curl --proto '=https' --tlsv1.2 -LsSf \
  https://github.com/LalitMaganti/syntaqlite/releases/latest/download/syntaqlite-cli-installer.sh \
  | sh

Windows:

powershell -ExecutionPolicy ByPass -c "irm https://github.com/LalitMaganti/syntaqlite/releases/latest/download/syntaqlite-cli-installer.ps1 | iex"

Cargo:

cargo install syntaqlite-cli

Verify it works:

syntaqlite --help

Format SQL

# From stdin
echo "select a,b,c from users where id=1 and active=true" | syntaqlite fmt

Output:

SELECT a, b, c
FROM users
WHERE id = 1
  AND active = true;

Format a file in place:

syntaqlite fmt -i query.sql

Format all SQL files in a project:

syntaqlite fmt -i "**/*.sql"

Options:

Validate SQL

syntaqlite validate schema.sql

If the file contains CREATE TABLE statements followed by queries, syntaqlite builds a schema from the DDL and validates the queries against it:

CREATE TABLE users (id INTEGER, name TEXT, email TEXT);

SELECT nme FROM users;

error: unknown column 'nme'
 --> schema.sql:3:8
  |
3 | SELECT nme FROM users;
  |        ^^^
  |
  = help: did you mean 'name'?

Embedded SQL (experimental)

Validate SQL strings extracted from Python or TypeScript source files:

syntaqlite validate --experimental-lang python app.py
syntaqlite validate --experimental-lang typescript app.ts

SQLite version pinning

Match your production SQLite version and compile flags:

syntaqlite validate --sqlite-version 3.41.0 \
  --sqlite-cflag SQLITE_ENABLE_MATH_FUNCTIONS \
  query.sql

See SQLite version and compile flags for details.

Inspect the parse tree

echo "SELECT 1 + 2" | syntaqlite ast

Prints a text dump of the abstract syntax tree.