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 tbl
You 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 placeholdersformat("SELECT * FROM tbl WHERE foo = @foo", { params: {foo: "'bar'"}}));// Indexed placeholdersformat("SELECT * FROM tbl WHERE foo = ?", { params: ["'bar'"]}));
Both result in:
SELECT *FROM tblWHERE 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 -h
usage: sqlfmt.js [-h] [-o OUTPUT] \[-l {bigquery,db2,hive,mariadb,mysql,n1ql,plsql,postgresql,redshift,spark,sql,tsql}] [-c CONFIG] [--version] [FILE]Prettier SQLpositional 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 exit
By 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-sql
SELECT *FROM tblWHERE id = 3
The 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
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.