inferrinizzard
Prettier SQL 
Prettier SQL is a JavaScript library for pretty-printing SQL queries.
It started as a port of a PHP Library, but has since considerably diverged.
Prettier SQL supports the following dialects:
- sql - Standard SQL
- bigquery - GCP BigQuery
- db2 - IBM DB2
- hive - Apache Hive
- mariadb - MariaDB
- mysql - MySQL
- n1ql - Couchbase N1QL
- plsql - Oracle PL/SQL
- postgresql - PostgreSQL
- redshift - Amazon Redshift
- spark - Spark
- tsql - SQL Server Transact-SQL
It does not support:
- Stored procedures.
- Changing of the delimiter type to something else than
;.
Table of contents
Install
Get the latest version from NPM:
npm install prettier-sqlAlso available with yarn:
yarn add prettier-sqlDocumentation
You can read more about how the library works in DOC.md
Usage
Usage as library
import { format } from 'prettier-sql';
console.log(format('SELECT * FROM tbl'));This will output:
SELECT
*
FROM
tblYou can also pass in configuration options:
format('SELECT * FROM tbl', {
language: 'spark', // Defaults to "sql" (see the above list of supported dialects)
indent: ' ', // Defaults to two spaces
uppercase: false, // Defaults to true
linesBetweenQueries: 2, // Defaults to 1
});Placeholders replacement
// 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'Usage from command line
The CLI tool will be installed under prettier-sql
and may be invoked via npx prettier-sql:
prettier-sql -husage: sqlfmt.js [-h] [-o OUTPUT] \
[-l {bigquery,db2,hive,mariadb,mysql,n1ql,plsql,postgresql,redshift,spark,sql,tsql}] [-c CONFIG] [--version] [FILE]
Prettier SQL
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)
-l, --language {bigquery,db2,hive,mariadb,mysql,n1ql,plsql,postgresql,redshift,spark,sql,tsql}
SQL dialect (defaults to standard sql)
-c, --config CONFIG
Path to config json file (will use default configs if unspecified)
--version show program's version number and exitBy default, the tool takes queries from stdin and processes them to stdout but
one can also name an input file name or use the --output option.
echo 'select * from tbl where id = 3' | prettier-sqlSELECT
*
FROM
tbl
WHERE
id = 3The tool also accepts a JSON config file with the --config option that takes this form: \
All fields are optional and all fields that are not specified will be filled with their default values
{
"indent": string,
"uppercase": boolean,
"keywordPosition": "standard" | "tenSpaceLeft" | "tenSpaceRight",
"newline": "always" | "lineWidth" | "never" | number,
"breakBeforeBooleanOperator": boolean,
"aliasAs": "always" | "select" | "never",
"tabulateAlias": boolean,
"commaPosition": "before" | "after" | "tabular",
"parenOptions": {
"openParenNewline": boolean,
"closeParenNewline": boolean
},
"lineWidth": number,
"linesBetweenQueries": number,
"denseOperators": boolean,
"semicolonNewline": boolean,
}Usage without NPM
If you don't use a module bundler, clone the repository, run npm install and grab a file from /dist directory to use inside a <script> tag.
This makes Prettier SQL available as a global variable window.prettierSql.
Usage with VSCode
Prettier SQL is also available as a VSCode extension here: \ https://marketplace.visualstudio.com/items?itemName=inferrinizzard.prettier-sql-vscode
Contributing
Please see CONTRIBUTING.md