# Interface: BaseFormattingOptions

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

Common formatting knobs shared by SqlFormatter and SqlPrinter.

Example

const formatter = new SqlFormatter({ keywordCase: 'upper', indentSize: 4 });
const { formattedSql } = formatter.format(SelectQueryParser.parse('select * from users'));

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

Extended by

• SqlFormatterOptions

Properties

indentSize?

optional indentSize: number

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

Number of spaces for indentation

---

indentChar?

optional indentChar: string

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

Character to use for indentation (logical 'space'/'tab' or literal control character)

---

newline?

optional newline: NewlineOption

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

Newline character style (logical 'lf'/'crlf'/'cr' or literal newline string)

---

keywordCase?

optional keywordCase: "none" | "upper" | "lower" | "preserve"

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

Case transformation for SQL keywords

---

commaBreak?

optional commaBreak: CommaBreakStyle

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

Style for comma line breaks

---

cteCommaBreak?

optional cteCommaBreak: CommaBreakStyle

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

Style for comma line breaks inside WITH clause definitions

---

valuesCommaBreak?

optional valuesCommaBreak: CommaBreakStyle

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

Style for comma line breaks inside VALUES clauses

---

andBreak?

optional andBreak: AndBreakStyle

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

Style for AND line breaks

---

orBreak?

optional orBreak: OrBreakStyle

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

Style for OR line breaks

---

joinOnBreak?

optional joinOnBreak: JoinOnBreakStyle

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

Style for JOIN ON line breaks

---

exportComment?

optional exportComment: boolean | CommentExportMode

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

Whether to export comments in formatted output

---

commentStyle?

optional commentStyle: CommentStyle

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

Comment formatting style

---

withClauseStyle?

optional withClauseStyle: WithClauseStyle

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

Formatting style for WITH clauses

---

parenthesesOneLine?

optional parenthesesOneLine: boolean

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

Keep parentheses content on one line regardless of AND/OR break settings

---

betweenOneLine?

optional betweenOneLine: boolean

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

Keep BETWEEN expressions on one line regardless of AND break settings

---

valuesOneLine?

optional valuesOneLine: boolean

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

Keep VALUES clause on one line regardless of comma break settings

---

inOneLine?

optional inOneLine: boolean

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

Keep IN value lists on one line until oneLineMaxLength forces expansion

---

joinOneLine?

optional joinOneLine: boolean

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

Keep JOIN conditions on one line regardless of AND/OR break settings

---

caseOneLine?

optional caseOneLine: boolean

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

Keep CASE expressions on one line regardless of formatting settings

---

subqueryOneLine?

optional subqueryOneLine: boolean

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

Keep subqueries (inline queries) on one line regardless of formatting settings

---

indentNestedParentheses?

optional indentNestedParentheses: boolean

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

Indent nested parentheses when boolean groups contain additional parentheses

---

insertColumnsOneLine?

optional insertColumnsOneLine: boolean

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

Keep INSERT column lists on one line regardless of comma break settings

---

whenOneLine?

optional whenOneLine: boolean

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

Keep MERGE WHEN clause predicates on one line regardless of AND break settings

---

oneLineMaxLength?

optional oneLineMaxLength: number | null

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

Maximum rendered width for opt-in one-line constructs. Use 0, null, or omit to disable the limit.

---

joinConditionContinuationIndent?

optional joinConditionContinuationIndent: boolean

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

Indent AND/OR continuation lines inside JOIN ON predicates

---

joinConditionOrderByDeclaration?

optional joinConditionOrderByDeclaration: boolean

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

Reorder JOIN ON column comparisons to follow table declaration order