SqlWriterConfig (Apache Calcite core API)

```
public interface SqlWriterConfig
```
Configuration for SqlWriter and SqlPrettyWriter.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class SqlWriterConfig.LineFolding
Policy for how to do deal with long lines.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`SqlWriterConfig.LineFolding` Policy for how to do deal with long lines.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`alwaysUseParentheses()` Returns whether expressions should always be included in parentheses.
`boolean`	`caseClausesOnNewLines()` Returns whether the WHEN, THEN and ELSE clauses of a CASE expression appear at the start of a new line.
`boolean`	`clauseEndsLine()` Returns whether a clause (FROM, WHERE, GROUP BY, HAVING, WINDOW, ORDER BY) is followed by a new line.
`boolean`	`clauseStartsLine()` Returns whether a clause (FROM, WHERE, GROUP BY, HAVING, WINDOW, ORDER BY) starts a new line.
`SqlDialect`	`dialect()` Returns the dialect.
`int`	`foldLength()` Returns the line length at which items are chopped or folded (for clauses that have chosen `SqlWriterConfig.LineFolding.CHOP` or `SqlWriterConfig.LineFolding.FOLD`).
`SqlWriterConfig.LineFolding`	`fromFolding()` Returns the line-folding policy for the FROM clause (and JOIN).
`SqlWriterConfig.LineFolding`	`groupByFolding()` Returns the line-folding policy for the GROUP BY clause.
`SqlWriterConfig.LineFolding`	`havingFolding()` Returns the line-folding policy for the HAVING clause.
`int`	`indentation()` Returns the number of spaces indentation.
`boolean`	`keywordsLowerCase()` Returns whether to print keywords (SELECT, AS, etc.) in lower-case.
`boolean`	`leadingComma()` Returns whether commas in SELECT, GROUP BY and ORDER clauses should appear at the start of the line.
`SqlWriterConfig.LineFolding`	`lineFolding()` Returns the line-folding policy for lists in the SELECT, GROUP BY and ORDER clauses, for items in the SET clause of UPDATE, and for items in VALUES.
`int`	`lineLength()` Returns the maximum line length.
`SqlWriterConfig.LineFolding`	`matchFolding()` Returns the line-folding policy for the MATCH_RECOGNIZE clause.
`SqlWriterConfig.LineFolding`	`orderByFolding()` Returns the line-folding policy for the ORDER BY clause.
`SqlWriterConfig.LineFolding`	`overFolding()` Returns the line-folding policy for the OVER clause or a window declaration.
`boolean`	`quoteAllIdentifiers()` Returns whether to quote all identifiers, even those which would be correct according to the rules of the `SqlDialect` if quotation marks were omitted.
`SqlWriterConfig.LineFolding`	`selectFolding()` Returns the line-folding policy for the SELECT clause.
`boolean`	`selectListExtraIndentFlag()` Returns whether to use a fix for SELECT list indentations.
`boolean`	`selectListItemsOnSeparateLines()` Returns whether each item in a SELECT list, GROUP BY list, or ORDER BY list is on its own line.
`SqlWriter.SubQueryStyle`	`subQueryStyle()` Returns the sub-query style.
`SqlWriterConfig.LineFolding`	`updateSetFolding()` Returns the line-folding policy for the SET clause of an UPDATE statement.
`boolean`	`updateSetListNewline()` Returns whether each assignment in the SET clause of an UPDATE or MERGE statement should be on its own line.
`SqlWriterConfig.LineFolding`	`valuesFolding()` Returns the line-folding policy for the VALUES expression.
`boolean`	`valuesListNewline()` Returns whether each row in a VALUES clause should be on its own line.
`SqlWriterConfig.LineFolding`	`whereFolding()` Returns the line-folding policy for the WHERE clause.
`boolean`	`whereListItemsOnSeparateLines()` Returns whether to print a newline before each AND or OR (whichever is higher level) in WHERE clauses.
`boolean`	`windowDeclListNewline()` Returns whether each declaration in a WINDOW clause should be on its own line.
`SqlWriterConfig.LineFolding`	`windowFolding()` Returns the line-folding policy for the WINDOW clause.
`boolean`	`windowNewline()` Returns whether a WINDOW clause should start its own line.
`SqlWriterConfig`	`withAlwaysUseParentheses(boolean alwaysUseParentheses)` Sets `alwaysUseParentheses()`.
`SqlWriterConfig`	`withCaseClausesOnNewLines(boolean caseClausesOnNewLines)` Sets `caseClausesOnNewLines()`.
`SqlWriterConfig`	`withClauseEndsLine(boolean clauseEndsLine)` Sets `clauseEndsLine()`.
`SqlWriterConfig`	`withClauseStartsLine(boolean clauseStartsLine)` Sets `clauseStartsLine()`.
`SqlWriterConfig`	`withDialect(SqlDialect dialect)` Sets `dialect()`.
`SqlWriterConfig`	`withFoldLength(int lineLength)` Sets `foldLength()`.
`SqlWriterConfig`	`withFromFolding(SqlWriterConfig.LineFolding lineFolding)` Sets `fromFolding()`.
`SqlWriterConfig`	`withGroupByFolding(SqlWriterConfig.LineFolding lineFolding)` Sets `groupByFolding()`.
`SqlWriterConfig`	`withHavingFolding(SqlWriterConfig.LineFolding lineFolding)` Sets `havingFolding()`.
`SqlWriterConfig`	`withIndentation(int indentation)` Sets `indentation()`.
`SqlWriterConfig`	`withKeywordsLowerCase(boolean keywordsLowerCase)` Sets `keywordsLowerCase()`.
`SqlWriterConfig`	`withLeadingComma(boolean leadingComma)` Sets `leadingComma()`.
`SqlWriterConfig`	`withLineFolding(SqlWriterConfig.LineFolding lineFolding)` Sets `lineFolding()`.
`SqlWriterConfig`	`withLineLength(int lineLength)` Sets `lineLength()`.
`SqlWriterConfig`	`withMatchFolding(SqlWriterConfig.LineFolding lineFolding)` Sets `matchFolding()`.
`SqlWriterConfig`	`withOrderByFolding(SqlWriterConfig.LineFolding lineFolding)` Sets `orderByFolding()`.
`SqlWriterConfig`	`withOverFolding(SqlWriterConfig.LineFolding lineFolding)` Sets `overFolding()`.
`SqlWriterConfig`	`withQuoteAllIdentifiers(boolean quoteAllIdentifiers)` Sets `quoteAllIdentifiers()`.
`SqlWriterConfig`	`withSelectFolding(SqlWriterConfig.LineFolding lineFolding)` Sets `selectFolding()`.
`SqlWriterConfig`	`withSelectListExtraIndentFlag(boolean selectListExtraIndentFlag)` Sets `selectListExtraIndentFlag()`.
`SqlWriterConfig`	`withSelectListItemsOnSeparateLines(boolean selectListItemsOnSeparateLines)` Sets `selectListItemsOnSeparateLines()`.
`SqlWriterConfig`	`withSubQueryStyle(SqlWriter.SubQueryStyle subQueryStyle)` Sets `subQueryStyle()`.
`SqlWriterConfig`	`withUpdateSetFolding(SqlWriterConfig.LineFolding lineFolding)` Sets `updateSetFolding()`.
`SqlWriterConfig`	`withUpdateSetListNewline(boolean updateSetListNewline)` Sets `updateSetListNewline()`.
`SqlWriterConfig`	`withValuesFolding(SqlWriterConfig.LineFolding lineFolding)` Sets `valuesFolding()`.
`SqlWriterConfig`	`withValuesListNewline(boolean valuesListNewline)` Sets `valuesListNewline()`.
`SqlWriterConfig`	`withWhereFolding(SqlWriterConfig.LineFolding lineFolding)` Sets `whereFolding()`.
`SqlWriterConfig`	`withWhereListItemsOnSeparateLines(boolean whereListItemsOnSeparateLines)` Sets `whereListItemsOnSeparateLines()`.
`SqlWriterConfig`	`withWindowDeclListNewline(boolean windowDeclListNewline)` Sets `windowDeclListNewline()`.
`SqlWriterConfig`	`withWindowFolding(SqlWriterConfig.LineFolding lineFolding)` Sets `windowFolding()`.
`SqlWriterConfig`	`withWindowNewline(boolean windowNewline)` Sets `windowNewline()`.

- Method Detail
  - dialect
```
SqlDialect dialect()
```
    Returns the dialect.
  - withDialect
```
SqlWriterConfig withDialect(SqlDialect dialect)
```
    Sets dialect().
  - keywordsLowerCase
```
boolean keywordsLowerCase()
```
    Returns whether to print keywords (SELECT, AS, etc.) in lower-case. Default is false: keywords are printed in upper-case.
  - withKeywordsLowerCase
```
SqlWriterConfig withKeywordsLowerCase(boolean keywordsLowerCase)
```
    Sets keywordsLowerCase().
  - quoteAllIdentifiers
```
boolean quoteAllIdentifiers()
```
    Returns whether to quote all identifiers, even those which would be correct according to the rules of the SqlDialect if quotation marks were omitted. Default is true.
  - withQuoteAllIdentifiers
```
SqlWriterConfig withQuoteAllIdentifiers(boolean quoteAllIdentifiers)
```
    Sets quoteAllIdentifiers().
  - indentation
```
int indentation()
```
    Returns the number of spaces indentation. Default is 4.
  - withIndentation
```
SqlWriterConfig withIndentation(int indentation)
```
    Sets indentation().
  - clauseStartsLine
```
boolean clauseStartsLine()
```
    Returns whether a clause (FROM, WHERE, GROUP BY, HAVING, WINDOW, ORDER BY) starts a new line. Default is true. SELECT is always at the start of a line.
  - withClauseStartsLine
```
SqlWriterConfig withClauseStartsLine(boolean clauseStartsLine)
```
    Sets clauseStartsLine().
  - clauseEndsLine
```
boolean clauseEndsLine()
```
    Returns whether a clause (FROM, WHERE, GROUP BY, HAVING, WINDOW, ORDER BY) is followed by a new line. Default is false.
  - withClauseEndsLine
```
SqlWriterConfig withClauseEndsLine(boolean clauseEndsLine)
```
    Sets clauseEndsLine().
  - selectListItemsOnSeparateLines
```
boolean selectListItemsOnSeparateLines()
```
    Returns whether each item in a SELECT list, GROUP BY list, or ORDER BY list is on its own line.
    Default is false; this property is superseded by selectFolding(), groupByFolding(), orderByFolding().
  - withSelectListItemsOnSeparateLines
```
SqlWriterConfig withSelectListItemsOnSeparateLines(boolean selectListItemsOnSeparateLines)
```
    Sets selectListItemsOnSeparateLines().
  - lineFolding
```
SqlWriterConfig.LineFolding lineFolding()
```
    Returns the line-folding policy for lists in the SELECT, GROUP BY and ORDER clauses, for items in the SET clause of UPDATE, and for items in VALUES.
    
    See Also:
    
    If not set, the values of {@link #selectListItemsOnSeparateLines()}, {@link #valuesListNewline()}, {@link #updateSetListNewline()}, {@link #windowDeclListNewline()} are used.
  - withLineFolding
```
SqlWriterConfig withLineFolding(SqlWriterConfig.LineFolding lineFolding)
```
    Sets lineFolding().
  - selectFolding
```
SqlWriterConfig.LineFolding selectFolding()
```
    Returns the line-folding policy for the SELECT clause. If not set, the value of lineFolding() is used.
  - withSelectFolding
```
SqlWriterConfig withSelectFolding(SqlWriterConfig.LineFolding lineFolding)
```
    Sets selectFolding().
  - fromFolding
```
SqlWriterConfig.LineFolding fromFolding()
```
    Returns the line-folding policy for the FROM clause (and JOIN). If not set, the value of lineFolding() is used.
  - withFromFolding
```
SqlWriterConfig withFromFolding(SqlWriterConfig.LineFolding lineFolding)
```
    Sets fromFolding().
  - whereFolding
```
SqlWriterConfig.LineFolding whereFolding()
```
    Returns the line-folding policy for the WHERE clause. If not set, the value of lineFolding() is used.
  - withWhereFolding
```
SqlWriterConfig withWhereFolding(SqlWriterConfig.LineFolding lineFolding)
```
    Sets whereFolding().
  - groupByFolding
```
SqlWriterConfig.LineFolding groupByFolding()
```
    Returns the line-folding policy for the GROUP BY clause. If not set, the value of lineFolding() is used.
  - withGroupByFolding
```
SqlWriterConfig withGroupByFolding(SqlWriterConfig.LineFolding lineFolding)
```
    Sets groupByFolding().
  - havingFolding
```
SqlWriterConfig.LineFolding havingFolding()
```
    Returns the line-folding policy for the HAVING clause. If not set, the value of lineFolding() is used.
  - withHavingFolding
```
SqlWriterConfig withHavingFolding(SqlWriterConfig.LineFolding lineFolding)
```
    Sets havingFolding().
  - windowFolding
```
SqlWriterConfig.LineFolding windowFolding()
```
    Returns the line-folding policy for the WINDOW clause. If not set, the value of lineFolding() is used.
  - withWindowFolding
```
SqlWriterConfig withWindowFolding(SqlWriterConfig.LineFolding lineFolding)
```
    Sets windowFolding().
  - matchFolding
```
SqlWriterConfig.LineFolding matchFolding()
```
    Returns the line-folding policy for the MATCH_RECOGNIZE clause. If not set, the value of lineFolding() is used.
  - withMatchFolding
```
SqlWriterConfig withMatchFolding(SqlWriterConfig.LineFolding lineFolding)
```
    Sets matchFolding().
  - orderByFolding
```
SqlWriterConfig.LineFolding orderByFolding()
```
    Returns the line-folding policy for the ORDER BY clause. If not set, the value of lineFolding() is used.
  - withOrderByFolding
```
SqlWriterConfig withOrderByFolding(SqlWriterConfig.LineFolding lineFolding)
```
    Sets orderByFolding().
  - overFolding
```
SqlWriterConfig.LineFolding overFolding()
```
    Returns the line-folding policy for the OVER clause or a window declaration. If not set, the value of lineFolding() is used.
  - withOverFolding
```
SqlWriterConfig withOverFolding(SqlWriterConfig.LineFolding lineFolding)
```
    Sets overFolding().
  - valuesFolding
```
SqlWriterConfig.LineFolding valuesFolding()
```
    Returns the line-folding policy for the VALUES expression. If not set, the value of lineFolding() is used.
  - withValuesFolding
```
SqlWriterConfig withValuesFolding(SqlWriterConfig.LineFolding lineFolding)
```
    Sets valuesFolding().
  - updateSetFolding
```
SqlWriterConfig.LineFolding updateSetFolding()
```
    Returns the line-folding policy for the SET clause of an UPDATE statement. If not set, the value of lineFolding() is used.
  - withUpdateSetFolding
```
SqlWriterConfig withUpdateSetFolding(SqlWriterConfig.LineFolding lineFolding)
```
    Sets updateSetFolding().
  - selectListExtraIndentFlag
```
boolean selectListExtraIndentFlag()
```
    Returns whether to use a fix for SELECT list indentations.
    - If set to "false":
      SELECT A as A, B as B, C as C, D
    - If set to "true" (the default):
      SELECT A as A, B as B, C as C, D
  - withSelectListExtraIndentFlag
```
SqlWriterConfig withSelectListExtraIndentFlag(boolean selectListExtraIndentFlag)
```
    Sets selectListExtraIndentFlag().
  - windowDeclListNewline
```
boolean windowDeclListNewline()
```
    Returns whether each declaration in a WINDOW clause should be on its own line.
    Default is true; this property is superseded by windowFolding().
  - withWindowDeclListNewline
```
SqlWriterConfig withWindowDeclListNewline(boolean windowDeclListNewline)
```
    Sets windowDeclListNewline().
  - valuesListNewline
```
boolean valuesListNewline()
```
    Returns whether each row in a VALUES clause should be on its own line.
    Default is true; this property is superseded by valuesFolding().
  - withValuesListNewline
```
SqlWriterConfig withValuesListNewline(boolean valuesListNewline)
```
    Sets valuesListNewline().
  - updateSetListNewline
```
boolean updateSetListNewline()
```
    Returns whether each assignment in the SET clause of an UPDATE or MERGE statement should be on its own line.
    Default is true; this property is superseded by updateSetFolding().
  - withUpdateSetListNewline
```
SqlWriterConfig withUpdateSetListNewline(boolean updateSetListNewline)
```
    Sets updateSetListNewline().
  - windowNewline
```
boolean windowNewline()
```
    Returns whether a WINDOW clause should start its own line.
  - withWindowNewline
```
SqlWriterConfig withWindowNewline(boolean windowNewline)
```
    Sets windowNewline().
  - leadingComma
```
boolean leadingComma()
```
    Returns whether commas in SELECT, GROUP BY and ORDER clauses should appear at the start of the line. Default is false.
  - withLeadingComma
```
SqlWriterConfig withLeadingComma(boolean leadingComma)
```
    Sets leadingComma().
  - subQueryStyle
```
SqlWriter.SubQueryStyle subQueryStyle()
```
    Returns the sub-query style. Default is SqlWriter.SubQueryStyle.HYDE.
  - withSubQueryStyle
```
SqlWriterConfig withSubQueryStyle(SqlWriter.SubQueryStyle subQueryStyle)
```
    Sets subQueryStyle().
  - whereListItemsOnSeparateLines
```
boolean whereListItemsOnSeparateLines()
```
    Returns whether to print a newline before each AND or OR (whichever is higher level) in WHERE clauses.
    NOTE: Ignored when alwaysUseParentheses is set to true.
  - withWhereListItemsOnSeparateLines
```
SqlWriterConfig withWhereListItemsOnSeparateLines(boolean whereListItemsOnSeparateLines)
```
    Sets whereListItemsOnSeparateLines().
  - alwaysUseParentheses
```
boolean alwaysUseParentheses()
```
    Returns whether expressions should always be included in parentheses. Default is false.
  - withAlwaysUseParentheses
```
SqlWriterConfig withAlwaysUseParentheses(boolean alwaysUseParentheses)
```
    Sets alwaysUseParentheses().
  - lineLength
```
int lineLength()
```
    Returns the maximum line length. Default is zero, which means there is no maximum.
  - withLineLength
```
SqlWriterConfig withLineLength(int lineLength)
```
    Sets lineLength().
  - foldLength
```
int foldLength()
```
    Returns the line length at which items are chopped or folded (for clauses that have chosen SqlWriterConfig.LineFolding.CHOP or SqlWriterConfig.LineFolding.FOLD). Default is 80.
  - withFoldLength
```
SqlWriterConfig withFoldLength(int lineLength)
```
    Sets foldLength().
  - caseClausesOnNewLines
```
boolean caseClausesOnNewLines()
```
    Returns whether the WHEN, THEN and ELSE clauses of a CASE expression appear at the start of a new line. The default is false.
  - withCaseClausesOnNewLines
```
SqlWriterConfig withCaseClausesOnNewLines(boolean caseClausesOnNewLines)
```
    Sets caseClausesOnNewLines().

Interface SqlWriterConfig

Nested Class Summary

Method Summary

Method Detail

dialect

withDialect

keywordsLowerCase

withKeywordsLowerCase

quoteAllIdentifiers

withQuoteAllIdentifiers

indentation

withIndentation

clauseStartsLine

withClauseStartsLine

clauseEndsLine

withClauseEndsLine

selectListItemsOnSeparateLines

withSelectListItemsOnSeparateLines

lineFolding

withLineFolding

selectFolding

withSelectFolding

fromFolding

withFromFolding

whereFolding

withWhereFolding

groupByFolding

withGroupByFolding

havingFolding

withHavingFolding

windowFolding

withWindowFolding

matchFolding

withMatchFolding

orderByFolding

withOrderByFolding

overFolding

withOverFolding

valuesFolding

withValuesFolding

updateSetFolding

withUpdateSetFolding

selectListExtraIndentFlag

withSelectListExtraIndentFlag

windowDeclListNewline

withWindowDeclListNewline

valuesListNewline

withValuesListNewline

updateSetListNewline

withUpdateSetListNewline

windowNewline

withWindowNewline

leadingComma

withLeadingComma

subQueryStyle

withSubQueryStyle

whereListItemsOnSeparateLines

withWhereListItemsOnSeparateLines

alwaysUseParentheses

withAlwaysUseParentheses

lineLength

withLineLength

foldLength

withFoldLength

caseClausesOnNewLines

withCaseClausesOnNewLines