SQL Pretty Printer format options Reference
- format options
- Select
-
select list
- gFmtOpt.Select_Columnlist_Style
- gFmtOpt.Select_Columnlist_Comma
- gFmtOpt.SelectItemInNewLine
- gFmtOpt.AlignAliasInSelectList
- gFmtOpt.TreatDistinctAsVirtualColumn
-
select from clause / Join clause
- gFmtOpt.Select_fromclause_Style
- gFmtOpt.Select_fromclause_Comma
- gFmtOpt.FromClauseInNewLine
- gFmtOpt.Select_FromclauseJoinOnInNewline
-
And/Or keyword under where
-
Group by Clause: use the same options as select list items
- gFmtOpt.Select_Columnlist_Style
- gFmtOpt.Select_Columnlist_Comma
- gFmtOpt.SelectItemInNewLine
-
Order by Clause: use the same options as select list items
- gFmtOpt.Select_Columnlist_Style
- gFmtOpt.Select_Columnlist_Comma
- gFmtOpt.SelectItemInNewLine
- Insert
-
insert list
- gFmtOpt.Insert_Columnlist_Style
- gFmtOpt.Insert_Valuelist_Style
- gFmtOpt.DefaultCommaOption
- Create table
-
Create table
- gFmtOpt.BEStyle_createtable_leftBEOnNewline, left parenthesis in new line
- gFmtOpt.BEStyle_createtable_rightBEOnNewline, right parenthesis in new line
- gFmtOpt.Createtable_ListitemInNewLine
- gFmtOpt.Createtable_Fieldlist_Align_option
- gFmtOpt.DefaultAligntype
- gFmtOpt.DefaultCommaOption
- Common Table Expression
- declare statement
- Execute statement
-
execute statement
- gFmtOpt.LinebreakBeforeParamInExec
- Beautify sql inside execute statement
- Parameters in create procedure/function
-
Parameters
- gFmtOpt.BEStyle_Function_leftBEOnNewline, left parenthesis of parameter in new line
- gFmtOpt.BEStyle_Function_leftBEIndentSize, indent of left parenthesis
- gFmtOpt.BEStyle_Function_rightBEOnNewline, right parenthesis of parameter in new line
- gFmtOpt.BEStyle_Function_rightBEIndentSize, indent of right parenthesis
- gFmtOpt.BEStyle_Function_FirstParamInNewline
- gFmtOpt.Parameters_Style
- gFmtOpt.Parameters_Comma
- Case expression/statement
-
When Then clause
- gFmtOpt.CaseWhenThenInSameLine
- gFmtOpt.Indent_CaseFromSwitch
- gFmtOpt.Indent_Case_Then
- Aignments
- Blank lines
- Blank lines
-
gFmtOpt.EmptyLines, handle of empty lines
-
gFmtOpt.InsertBlankLineInBatchSqls, blank lines between sql statements
- Whitespace
- Padding
- gFmtOpt.WSPadding_OperatorArithmetic, space around operator of arithmetic expression.
- gFmtOpt.WSPadding_ParenthesesInFunction, space inside Parenthesis in create function/procedure
- gFmtOpt.WSPadding_ParenthesesInExpression, space inside Parenthesis in expression
- gFmtOpt.WSPadding_ParenthesesOfSubQuery, space inside Parenthesis in subquery
- gFmtOpt.WSPadding_ParenthesesInFunctionCall, space inside Parenthesis in function call.
- gFmtOpt.WSPadding_ParenthesesOfTypename, space inside Parenthesis of typename in create table.
- Indentation
- General
-
gFmtOpt.IndentLen, general indentation size, used to indent if no specific indent option provided.
-
gFmtOpt.UseTab, Use tab to indent, if other indent size less than gFmtOpt.TabSize, then all that size will
be set to gFmtOpt.TabSize. this option works only when output is plain text.
- gFmtOpt.TabSize
- Block/Begin..End
- gFmtOpt.BEStyle_Function_BodyIndent,
function body indent size, stmts inside create function/procedure/trigger. indent from top function level.
if first statement is a block(begin .. end), then indent was determined by BEStyle_Block_leftBEIndentSize
- gFmtOpt.BEStyle_Block_leftBEOnNewline, begin keyword in new line, apply to begin keyword in if/while/loop statement only.
- gFmtOpt.BEStyle_Block_leftBEIndentSize, indent of begin keyword
-
gFmtOpt.BEStyle_Block_rightBEIndentSize,indent of end keyword
- gFmtOpt.BEStyle_BlockIndentSize, block body indent size, stmts inside begin/end. indent from begin keywords
-
gFmtOpt.BEStyle_IfElseSingleStmtIndentSize, Indent size of single stmt in if stmt.
- Capitalisation
- Case options for various token
-
gFmtOpt.case_keywords
-
gFmtOpt.case_identifier
-
gFmtOpt.case_quoted_Identifier
-
gFmtOpt.case_funcname
-
gFmtOpt.case_builtinfunc (not available yet)
-
gFmtOpt.case_datatype
-
gFmtOpt.DictionaryFile, used to find word when TCaseOption is set to coInitCapEachWord
- Line Width
- Line width options
- gFmtOpt.LineWidth, max line width
-
gFmtOpt.CompactMode, compact output to a fixed line width.
- Line Number
- Show line number options
- gFmtOpt.linenumber_enabled, show line number if it's true
-
gFmtOpt.linenumber_0_based, line number start from 0 if it's true, otherwise, start from 1.
- gFmtOpt.linenumber_leftmargin, space before line number.
- gFmtOpt.linenumber_rightmargin, space after line number.
- Comments
- comment options
- gFmtOpt.remove_comment, reomve comments in script
-
--begin_no_format, --end_no_format, comment used to keep layout of original sql block.
Syntax highlighting
- fontname,gfmtopt.HighlightingFontname
- fontsize,gfmtopt.HighlightingFontsize
- Syntax highlighting for various token(valid when output is html or RTF)
-
gFmtOpt.HighlightingElements[sfkIdentifer]
-
gFmtOpt.HighlightingElements[sfkstandardkeyword]
-
gFmtOpt.HighlightingElements[sfkNumber]
-
gFmtOpt.HighlightingElements[sfkDelimitedIdentifier]
- gFmtOpt.HighlightingElements[sfkSymbol]
- gFmtOpt.HighlightingElements[sfkFunction]
- gFmtOpt.HighlightingElements[sfkBuiltInFunction]
-
gFmtOpt.HighlightingElements[sfkDatatype]
-
gFmtOpt.HighlightingElements[sfkParameter]
- gFmtOpt.HighlightingElements[sfkbindvar]
- gFmtOpt.HighlightingElements[sfkVendordbkeyword]
- gFmtOpt.HighlightingElements[sfkSQString]
- gFmtOpt.HighlightingElements[sfkDQString]
-
gFmtOpt.HighlightingElements[sfkComment_dh]
-
gFmtOpt.HighlightingElements[sfkComment_ss]
-
gFmtOpt.HighlightingElements[sfkComment_sign]
- gFmtOpt.HighlightingElements[sfkmssqlsystemvar]
- gFmtOpt.HighlightingElements[sfksqlvar]
- gFmtOpt.HighlightingElements[sfkmssqlst1]
- gFmtOpt.HighlightingElements[sfkmssqlst2]
- gFmtOpt.HighlightingElements[sfkmssqlst3]
- gFmtOpt.HighlightingElements[sfkOracleplsqlkeyword]
- gFmtOpt.HighlightingElements[sfkoracleexception]
- gFmtOpt.HighlightingElements[sfkOraclepackage]
- gFmtOpt.HighlightingElements[sfkOraclecommand]
- gFmtOpt.HighlightingElements[sfkOracleplsqlmethod]
- gFmtOpt.HighlightingElements[sfkOraclerem]
- gFmtOpt.HighlightingElements[sfkoraclesqlplus]
- gFmtOpt.HighlightingElements[sfkOpenBracket]
- gFmtOpt.HighlightingElements[sfkCloseBracket]
Preprocess
- Preprocess options
-
gFmtOpt.RemoveLinebreakBeforeParse, remove linebreaks of input before format sql.
-
gFmtOpt.TrimQuotedCharOfEachline, remove quoted char of input before format sql.
-
gFmtOpt.QuotedCharOfEachLine, char need to be removed when gFmtOpt.TrimQuotedCharOfEachline is true.
- Database(gfmtopt.DbVendor, TDBVendor)
- MS-SQL
- Oracle
- MySQL
- MS-ACCESS
- Generic
- DB2
- Sybase
- Informix
- Postgresql
- Firebird
- Mdx
- Outputfmt(gfmtopt.OutputFmt, TOutputFmt)
- Varname for each output type,gfmtopt.OutputVarname
- Sql
- ShortCut for each output type, gfmtopt.sql_shortcut
- Hotkey for each output type, gfmtopt.sql_shortcut
- Csharp
- CSharpFirstLineStr
- CSharpFirstCharOfEachLine
- CSharpLastCharOfEachLine
- CSharpLastCharOfLastLine
- ShortCut for each output type, gfmtopt.csharp_shortcut
- Hotkey for each output type, gfmtopt.csharp_shortcut
- Csharpsbd
- CSharpsbFirstLineStr
- CSharpsbFirstCharOfEachLine
- CSharpsbLastCharOfEachLine
- CSharpsbLastCharOfLastLine
- ShortCut for each output type, gfmtopt.csharpsbd_shortcut
- Hotkey for each output type, gfmtopt.csharpsbd_shortcut
- vb
- vbFirstLineStr
- vbFirstCharOfEachLine
- vbLastCharOfEachLine
- vbLastCharOfLastLine
- ShortCut for each output type, gfmtopt.vb_shortcut
- Hotkey for each output type, gfmtopt.vb_shortcut
- vbsbd
- vbsbFirstLineStr
- vbsbFirstCharOfEachLine
- vbsbLastCharOfEachLine
- vbsbLastCharOfLastLine
- ShortCut for each output type, gfmtopt.vbsbd_shortcut
- Hotkey for each output type, gfmtopt.vbsbd_shortcut
- java
- javaFirstLineStr
- javaFirstCharOfEachLine
- javaLastCharOfEachLine
- javaLastCharOfLastLine
- ShortCut for each output type, gfmtopt.java_shortcut
- Hotkey for each output type, gfmtopt.java_shortcut
- javasbf
- javasbFirstLineStr
- javasbFirstCharOfEachLine
- javasbLastCharOfEachLine
- javasbLastCharOfLastLine
- ShortCut for each output type, gfmtopt.javasbf_shortcut
- Hotkey for each output type, gfmtopt.javasbf_shortcut
- vc
- vcFirstLineStr
- vcFirstCharOfEachLine
- vcLastCharOfEachLine
- vcLastCharOfLastLine
- ShortCut for each output type, gfmtopt.vc_shortcut
- Hotkey for each output type, gfmtopt.vc_shortcut
- pascal
- PascalFirstLineStr
- PascalFirstCharOfEachLine
- PascalLastCharOfEachLine
- PascalLastCharOfLastLine
- ShortCut for each output type, gfmtopt.pascal_shortcut
- Hotkey for each output type, gfmtopt.pascal_shortcut
- php
- phpFirstLineStr
- phpFirstCharOfEachLine
- phpLastCharOfEachLine
- phpLastCharOfLastLine
- ShortCut for each output type, gfmtopt.php_shortcut
- Hotkey for each output type, gfmtopt.php_shortcut
- proc
- procobol
- html
- html2
- htmlkeeplayout
- htmlkeeplayout2
- htmlkeeplayoutmodifycase
- htmlkeeplayout2modifycase
- txtmodifycase
- xml
- dbobject
- rtf
- rtfkeeplayout
- rtfkeeplayoutmodifycase
- Formatting type and value reference
- Reference
-
TAlignStyle
-
TAlignOption
-
TLinefeedsCommaOption
-
TCaseOption
-
TEmptyLinesOption
- TLzHighlightingElement
- TDBVendor
- TOutputFmt
- TCompactMode