Skip to content
A PostgreSQL SQL syntax beautifier.
JavaScript
Branch: master
Clone or download
Latest commit dbf043a Nov 5, 2019

README.md

pg-formatter

Travis build status Coveralls NPM version Canonical Code Style Twitter Follow

A PostgreSQL SQL syntax beautifier.

Note:

This project is a thin wrapper of https://github.com/darold/pgFormatter. Execution of the module relies on Perl being available on the host system.

Usage

import {
  format
} from 'pg-formatter';

format(`SELECT foo FROM bar`);

Configuration

Configuration Format Default Description pgFormatter equivalent
anonymize boolean false Obscure all literals in queries, useful to hide confidential data before formatting. anonymize
functionCase string ("unchanged", "lowercase", "uppercase", "capitalize") unchanged Change the case of the function names. function-case
keywordCase string ("unchanged", "lowercase", "uppercase", "capitalize") unchanged Change the case of the reserved keyword. keyword-case
spaces number 4 Number of spaces to indent the code. spaces
stripComments boolean false Remove any comment from SQL code. nocomment
placeholder string (regex) N/A Regex to find code that must not be changed. placeholder
You can’t perform that action at this time.