SQL Formatter is a JavaScript library for pretty-printing SQL queries.
It started as a port of a PHP Library, but has since considerably diverged.
It supports various SQL dialects: GCP BigQuery, Clickhouse, IBM DB2, DuckDB, Apache Hive, MariaDB, MySQL, TiDB, Couchbase N1QL, Oracle PL/SQL, PostgreSQL, Amazon Redshift, SingleStoreDB, Snowflake, Spark, SQL Server Transact-SQL, Trino (and Presto). See language option docs for more details.
It does not support:
- Stored procedures.
- Changing of the delimiter type to something else than
;.
Install
Get the latest version from NPM:
Also available with yarn:
Usage
Usage as library
console.log(format('SELECT * FROM tbl', { language: 'mysql' }));
This will output:
*
FROM
tbl
You can also pass in configuration options:
language: 'spark',
tabWidth: 2,
keywordCase: 'upper',
linesBetweenQueries: 2,
});
Disabling the formatter
You can disable the formatter for a section of SQL by surrounding it with disable/enable comments:
SELECT * FROM tbl1;
/* sql-formatter-enable */
SELECT * FROM tbl2;
which produces:
SELECT * FROM tbl1;
/* sql-formatter-enable */
SELECT
*
FROM
tbl2;
The formatter doesn't even parse the code between these comments. So in case there's some SQL that happens to crash SQL Formatter, you can comment the culprit out (at least until the issue gets fixed in SQL Formatter).
Placeholders replacement
In addition to formatting, this library can also perform placeholder replacement in prepared SQL statements:
params: ["'bar'"],
});
Results in:
*
FROM
tbl
WHERE
foo = 'bar'
For more details see docs of params option.
Usage from command line
The CLI tool will be installed under sql-formatter
and may be invoked via npx sql-formatter:
usage: sql-formatter [-h] [-o OUTPUT] \
[-l {bigquery,clickhouse,db2,db2i,hive,mariadb,mysql,n1ql,plsql, postgresql,redshift,singlestoredb,snowflake,spark,sql,sqlite ,tidb,transactsql,trino,tsql}] [-c CONFIG] [--version] [FILE]
SQL Formatter
positional arguments:
FILE Input SQL file (defaults to stdin)
optional arguments:
-h, --help show this help message and exit
-o, --output OUTPUT
File to write SQL output (defaults to stdout)
--fix Update the file in-place
-l, --language {bigquery,clickhouse,db2,db2i,hive,mariadb,mysql,n1ql,plsql,postgresql,redshift,singlestoredb,snowflake,spark,sql,sqlite,tidb,trino,tsql}
SQL dialect (defaults to basic sql)
-c, --config CONFIG
Path to config JSON file or json string (will find a file named '.sql-formatter.json' or use default configs if unspecified)
--version show program's version number and exit