Defined in: packages/core/src/transformers/CTEQueryDecomposer.ts:31
Options for CTEQueryDecomposer extending SqlFormatterOptions
Extends
Properties
addComments?
optional
addComments:boolean
Defined in: packages/core/src/transformers/CTEQueryDecomposer.ts:33
Whether to add comments to decomposed queries showing metadata and dependencies
indentSize?
optional
indentSize:number
Defined in: packages/core/src/transformers/SqlFormatter.ts:39
Number of spaces for indentation
Inherited from
SqlFormatterOptions
.indentSize
indentChar?
optional
indentChar:string
Defined in: packages/core/src/transformers/SqlFormatter.ts:41
Character to use for indentation ('space' or 'tab')
Inherited from
SqlFormatterOptions
.indentChar
newline?
optional
newline:NewlineOption
Defined in: packages/core/src/transformers/SqlFormatter.ts:43
Newline character style
Inherited from
keywordCase?
optional
keywordCase:"none"
|"upper"
|"lower"
Defined in: packages/core/src/transformers/SqlFormatter.ts:45
Case transformation for SQL keywords
Inherited from
SqlFormatterOptions
.keywordCase
commaBreak?
optional
commaBreak:CommaBreakStyle
Defined in: packages/core/src/transformers/SqlFormatter.ts:47
Style for comma line breaks
Inherited from
SqlFormatterOptions
.commaBreak
cteCommaBreak?
optional
cteCommaBreak:CommaBreakStyle
Defined in: packages/core/src/transformers/SqlFormatter.ts:49
Style for comma line breaks inside WITH clause definitions
Inherited from
SqlFormatterOptions
.cteCommaBreak
andBreak?
optional
andBreak:AndBreakStyle
Defined in: packages/core/src/transformers/SqlFormatter.ts:51
Style for AND/OR line breaks
Inherited from
exportComment?
optional
exportComment:boolean
Defined in: packages/core/src/transformers/SqlFormatter.ts:53
Whether to export comments in formatted output
Inherited from
SqlFormatterOptions
.exportComment
strictCommentPlacement?
optional
strictCommentPlacement:boolean
Defined in: packages/core/src/transformers/SqlFormatter.ts:55
Whether to only export comments from clause-level keywords
Inherited from
SqlFormatterOptions
.strictCommentPlacement
commentStyle?
optional
commentStyle:CommentStyle
Defined in: packages/core/src/transformers/SqlFormatter.ts:57
Comment formatting style
Inherited from
SqlFormatterOptions
.commentStyle
withClauseStyle?
optional
withClauseStyle:WithClauseStyle
Defined in: packages/core/src/transformers/SqlFormatter.ts:59
Formatting style for WITH clauses
Inherited from
SqlFormatterOptions
.withClauseStyle
parenthesesOneLine?
optional
parenthesesOneLine:boolean
Defined in: packages/core/src/transformers/SqlFormatter.ts:61
Keep parentheses content on one line regardless of AND/OR break settings
Inherited from
SqlFormatterOptions
.parenthesesOneLine
betweenOneLine?
optional
betweenOneLine:boolean
Defined in: packages/core/src/transformers/SqlFormatter.ts:63
Keep BETWEEN expressions on one line regardless of AND break settings
Inherited from
SqlFormatterOptions
.betweenOneLine
valuesOneLine?
optional
valuesOneLine:boolean
Defined in: packages/core/src/transformers/SqlFormatter.ts:65
Keep VALUES clause on one line regardless of comma break settings
Inherited from
SqlFormatterOptions
.valuesOneLine
joinOneLine?
optional
joinOneLine:boolean
Defined in: packages/core/src/transformers/SqlFormatter.ts:67
Keep JOIN conditions on one line regardless of AND/OR break settings
Inherited from
SqlFormatterOptions
.joinOneLine
caseOneLine?
optional
caseOneLine:boolean
Defined in: packages/core/src/transformers/SqlFormatter.ts:69
Keep CASE expressions on one line regardless of formatting settings
Inherited from
SqlFormatterOptions
.caseOneLine
subqueryOneLine?
optional
subqueryOneLine:boolean
Defined in: packages/core/src/transformers/SqlFormatter.ts:71
Keep subqueries (inline queries) on one line regardless of formatting settings
Inherited from
SqlFormatterOptions
.subqueryOneLine
preset?
optional
preset:"mysql"
|"postgres"
|"sqlserver"
|"sqlite"
Defined in: packages/core/src/transformers/SqlFormatter.ts:87
Database preset for formatting style ('mysql', 'postgres', 'sqlserver', 'sqlite')
Inherited from
identifierEscape?
optional
identifierEscape:object
Defined in: packages/core/src/transformers/SqlFormatter.ts:89
Custom identifier escape characters (e.g., {start: '"', end: '"'} for PostgreSQL)
start
start:
string
end
end:
string
Inherited from
SqlFormatterOptions
.identifierEscape
parameterSymbol?
optional
parameterSymbol:string
| {start
:string
;end
:string
; }
Defined in: packages/core/src/transformers/SqlFormatter.ts:91
Parameter symbol configuration for SQL parameters
Inherited from
SqlFormatterOptions
.parameterSymbol
parameterStyle?
optional
parameterStyle:"named"
|"indexed"
|"anonymous"
Defined in: packages/core/src/transformers/SqlFormatter.ts:93
Style for parameter formatting