Format whitespace in a SQL query to make it more readable
npm install @hokaccha/sql-formatterForked from zeroturnaround/sql-formatter but with improvements and ported Typescript.
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.
SQL formatter supports the following dialects:
- sql - Standard SQL
- mariadb - MariaDB
- mysql - MySQL
- postgresql - PostgreSQL
- db2 - IBM DB2
- plsql - Oracle PL/SQL
- n1ql - Couchbase N1QL
- redshift - Amazon Redshift
- spark - Spark
- tsql - SQL Server Transact-SQL
- bigquery - Google BigQuery
It does not support:
- Stored procedures.
- Changing of the delimiter type to something else than ;.
Get the latest version from NPM:
``sh`
npm install @hokaccha/sql-formatter
`js
import { format } from "sql-formatter";
console.log(format("SELECT * FROM tbl"));
`
This will output:
`sql`
SELECT
*
FROM
tbl
You can also pass in configuration options:
`js`
format("SELECT * FROM tbl", {
language: "spark", // Defaults to "sql" (see the above list of supported dialects)
indent: " ", // Defaults to two spaces
keywordCase: "upper", // Defaults to preserve ("upper" | "lower" | "preserve")
linesBetweenQueries: 2, // Defaults to 1
});
`js
// Named placeholders
format("SELECT * FROM tbl WHERE foo = @foo", {
params: {foo: "'bar'"}
}));
// Indexed placeholders
format("SELECT * FROM tbl WHERE foo = ?", {
params: ["'bar'"]
}));
`
Both result in:
`
SELECT
*
FROM
tbl
WHERE
foo = 'bar'