SQLTools Formatter

Forked from zeroturnaround/sql-formatter but with improvements and ported Typescript.

This package is part of vscode-sqltools extension.

→ Try it online using our playground.

Install

Get the latest version from NPM/Yarn:

npm install @sqltools/formatter
#
yarn add @sqltools/formatter

Usage

import sqlFormatter from '@sqltools/formatter';

console.log(sqlFormatter.format('SELECT * FROM table1'));

Will output:

SELECT *
FROM table1

You can also pass in configuration options:

sqlFormatter.format('SELECT *', {
  language: 'sql',
  indent: '\t', // Defaults to two spaces
});

Options

| option | description | type | default | | ------------------- | ------------------------------------------------ | ---------------------------------------------------------- | ------------------ | | language | Query language, default is Standard SQL | sql, n1ql, db2, pl/sql | sql | | indent | Characters used for indentation | string | (2 spaces) | | reservedWordCase | How to change the case of reserved words | upper, lower, null | null (no change) | | linesBetweenQueries | How many line breaks between queries | number or 'preserve' | 1 | | params | Collection of params for placeholder replacement | object for name params, array for indexed placeholders | |

Changelog

v1.2.4

• Support PostgreSQL c-style escape strings in formatter. #935 - thanks to @sivaramasubramanian.
• Support PostgreSQL @@ operator in formatter. #936 - thanks to @remlse.

v1.2.3

• Update types path. Thanks to @sgtpep
• Update README.md. Thanks to @hacker0limbo

v1.2.2

• Add playground link and options to README.md
• Emitting declarations files for usage with Typescript.

v1.2.1

• Fixes JSON operators not inserting spaces. Issue #605
• Fixes Grant type queries. Issue #460

v1.2.1

• (Almost) first public version