Format and Check

Format

pgembed format "select id,title from books where id=1"
pgembed format -f query.sql --write                    # rewrite the file
pgembed format -f query.sql -f other.sql --check || true   # exits 1 when one is not formatted: a CI lint

^{snippet source | anchor}

Formatting uses the PostgreSQL parser and keeps comments. It needs no server. Every statement ends with a semicolon. --check makes it a CI lint: it lists the files that are not formatted and exits 1.

SELECT id, title
FROM books
WHERE id = 1;

Check

sql --check checks the syntax offline and summarizes each statement: its kind, the tables it reads, writes or defines, the functions it calls, and whether it would ask before running. See SQL: check without running.