@hokaccha/sql-formatter
Version:
Format whitespace in a SQL query to make it more readable
40 lines (39 loc) • 1.71 kB
TypeScript
import type { KeywordCase } from "./core/Formatter";
import type { PlaceholderParams } from "./core/Params";
import BigQueryFormatter from "./languages/BigQueryFormatter";
import Db2Formatter from "./languages/Db2Formatter";
import MariaDbFormatter from "./languages/MariaDbFormatter";
import MySqlFormatter from "./languages/MySqlFormatter";
import N1qlFormatter from "./languages/N1qlFormatter";
import PlSqlFormatter from "./languages/PlSqlFormatter";
import PostgreSqlFormatter from "./languages/PostgreSqlFormatter";
import RedshiftFormatter from "./languages/RedshiftFormatter";
import SparkSqlFormatter from "./languages/SparkSqlFormatter";
import StandardSqlFormatter from "./languages/StandardSqlFormatter";
import TSqlFormatter from "./languages/TSqlFormatter";
declare const formatters: {
readonly db2: typeof Db2Formatter;
readonly mariadb: typeof MariaDbFormatter;
readonly mysql: typeof MySqlFormatter;
readonly n1ql: typeof N1qlFormatter;
readonly plsql: typeof PlSqlFormatter;
readonly postgresql: typeof PostgreSqlFormatter;
readonly redshift: typeof RedshiftFormatter;
readonly spark: typeof SparkSqlFormatter;
readonly sql: typeof StandardSqlFormatter;
readonly tsql: typeof TSqlFormatter;
readonly bigquery: typeof BigQueryFormatter;
};
export declare type Language = keyof typeof formatters;
export { KeywordCase };
export declare type FormatConfig = {
language?: Language;
indent?: string;
keywordCase?: KeywordCase;
linesBetweenQueries?: number;
params?: PlaceholderParams;
};
/**
* Format whitespace in a query to make it easier to read.
*/
export declare const format: (query: string, config?: FormatConfig) => string;