SQL Formatter Plus

Why this fork exist: see PR - work with esbuild and adjust tidb sql.

---

A fork of SQL Formatter with some extra bug fixes and features.

Fixes:

• Fixed formatting issue with unicode characters
• Fixed comment formatting for non-unix line endings
• Fixed null reference on input tokenization
• Fixed indentation of multiple statements

New Features:

• Convert keywords to uppercase with the uppercase config option
• Configurable number of line breaks between queries with the linesBetweenQueries config option

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 Standard SQL, Couchbase N1QL, IBM DB2 and Oracle PL/SQL dialects.

Try the demo.

Install

Get the latest version from NPM:

1npm install @baurine/sql-formatter-plus

Usage

1import sqlFormatter from '@baurine/sql-formatter-plus';
2
3console.log(sqlFormatter.format('SELECT * FROM table1'));

This will output:

1SELECT
2  *
3FROM
4  table1

You can also pass in configuration options:

1sqlFormatter.format('SELECT *', {
2  language: 'n1ql', // Defaults to "sql"
3  indent: '    ', // Defaults to two spaces,
4  uppercase: true, // Defaults to false
5  linesBetweenQueries: 2 // Defaults to 1
6});

Currently just four SQL dialects are supported:

• sql - Standard SQL
• n1ql - Couchbase N1QL
• db2 - IBM DB2
• pl/sql - Oracle PL/SQL

Placeholders replacement

1// Named placeholders
2sqlFormatter.format("SELECT * FROM tbl WHERE foo = @foo", {
3  params: {foo: "'bar'"}
4}));
5
6// Indexed placeholders
7sqlFormatter.format("SELECT * FROM tbl WHERE foo = ?", {
8  params: ["'bar'"]
9}));

Both result in:

1SELECT
2  *
3FROM
4  tbl
5WHERE
6  foo = 'bar'

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 SQL Formatter available as a global variable window.sqlFormatter.

Contributing

1# run linter and tests
2npm run check

...and you're ready to poke us with a pull request.

License

MIT