# Class: SqlFormatter

Defined in: packages/core/src/transformers/SqlFormatter.ts:123

High level facade that parses a SqlComponent, applies formatting rules, and prints the final SQL text.

Example

const formatter = new SqlFormatter({ keywordCase: 'lower', withClauseStyle: 'cte-oneline' });
const query = SelectQueryParser.parse('WITH cte AS (SELECT id FROM users) SELECT * FROM cte');
const { formattedSql } = formatter.format(query);

Related tests: packages/core/tests/transformers/SqlFormatter.case.test.ts

Constructors

Constructor

new SqlFormatter(options): SqlFormatter

Defined in: packages/core/src/transformers/SqlFormatter.ts:127

Parameters

options

SqlFormatterOptions = {}

Returns

SqlFormatter

Methods

format()

format(sql): object

Defined in: packages/core/src/transformers/SqlFormatter.ts:190

Formats a SQL query string with the given parameters.

Parameters

sql

SqlComponent

Returns

object

An object containing the formatted SQL string and the parameters.

formattedSql

formattedSql: string

params

params: any[] | Record<string, any&gt;