Package org.apache.calcite.sql

Interface SqlWriterConfig

@Immutable
public interface SqlWriterConfig

Configuration for SqlWriter and SqlPrettyWriter.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	SqlWriterConfig.LineFolding	Policy for how to do deal with long lines.

Method Summary

Modifier and Type	Method	Description
default boolean	alwaysUseParentheses()	Returns whether expressions should always be included in parentheses.
default boolean	caseClausesOnNewLines()	Returns whether the WHEN, THEN and ELSE clauses of a CASE expression appear at the start of a new line.
default boolean	clauseEndsLine()	Returns whether a clause (FROM, WHERE, GROUP BY, HAVING, WINDOW, ORDER BY) is followed by a new line.
default boolean	clauseStartsLine()	Returns whether a clause (FROM, WHERE, GROUP BY, HAVING, WINDOW, ORDER BY) starts a new line.
@Nullable SqlDialect	dialect()	Returns the dialect.
default 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 SqlWriterConfig.LineFolding	fromFolding()	Returns the line-folding policy for the FROM clause (and JOIN).
@Nullable SqlWriterConfig.LineFolding	groupByFolding()	Returns the line-folding policy for the GROUP BY clause.
@Nullable SqlWriterConfig.LineFolding	havingFolding()	Returns the line-folding policy for the HAVING clause.
default int	indentation()	Returns the number of spaces indentation.
default boolean	keywordsLowerCase()	Returns whether to print keywords (SELECT, AS, etc.) in lower-case.
default boolean	leadingComma()	Returns whether commas in SELECT, GROUP BY and ORDER clauses should appear at the start of the line.
@Nullable 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.
default int	lineLength()	Returns the maximum line length.
@Nullable SqlWriterConfig.LineFolding	matchFolding()	Returns the line-folding policy for the MATCH_RECOGNIZE clause.
static SqlWriterConfig	of()	Create a default SqlWriterConfig object.
@Nullable SqlWriterConfig.LineFolding	orderByFolding()	Returns the line-folding policy for the ORDER BY clause.
@Nullable SqlWriterConfig.LineFolding	overFolding()	Returns the line-folding policy for the OVER clause or a window declaration.
default 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.
@Nullable SqlWriterConfig.LineFolding	selectFolding()	Returns the line-folding policy for the SELECT clause.
default boolean	selectListExtraIndentFlag()	Returns whether to use a fix for SELECT list indentations.
default boolean	selectListItemsOnSeparateLines()	Returns whether each item in a SELECT list, GROUP BY list, or ORDER BY list is on its own line.
default SqlWriter.SubQueryStyle	subQueryStyle()	Returns the sub-query style.
@Nullable SqlWriterConfig.LineFolding	updateSetFolding()	Returns the line-folding policy for the SET clause of an UPDATE statement.
default boolean	updateSetListNewline()	Returns whether each assignment in the SET clause of an UPDATE or MERGE statement should be on its own line.
@Nullable SqlWriterConfig.LineFolding	valuesFolding()	Returns the line-folding policy for the VALUES expression.
default boolean	valuesListNewline()	Returns whether each row in a VALUES clause should be on its own line.
@Nullable SqlWriterConfig.LineFolding	whereFolding()	Returns the line-folding policy for the WHERE clause.
default boolean	whereListItemsOnSeparateLines()	Returns whether to print a newline before each AND or OR (whichever is higher level) in WHERE clauses.
default boolean	windowDeclListNewline()	Returns whether each declaration in a WINDOW clause should be on its own line.
@Nullable SqlWriterConfig.LineFolding	windowFolding()	Returns the line-folding policy for the WINDOW clause.
default 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(@Nullable SqlDialect dialect)	Sets dialect().
SqlWriterConfig	withFoldLength(int lineLength)	Sets foldLength().
SqlWriterConfig	withFromFolding(SqlWriterConfig.LineFolding lineFolding)	Sets fromFolding().
SqlWriterConfig	withGroupByFolding(@Nullable SqlWriterConfig.LineFolding lineFolding)	Sets groupByFolding().
SqlWriterConfig	withHavingFolding(@Nullable 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(@Nullable SqlWriterConfig.LineFolding lineFolding)	Sets lineFolding().
SqlWriterConfig	withLineLength(int lineLength)	Sets lineLength().
SqlWriterConfig	withMatchFolding(@Nullable SqlWriterConfig.LineFolding lineFolding)	Sets matchFolding().
SqlWriterConfig	withOrderByFolding(@Nullable SqlWriterConfig.LineFolding lineFolding)	Sets orderByFolding().
SqlWriterConfig	withOverFolding(@Nullable SqlWriterConfig.LineFolding lineFolding)	Sets overFolding().
SqlWriterConfig	withQuoteAllIdentifiers(boolean quoteAllIdentifiers)	Sets quoteAllIdentifiers().
SqlWriterConfig	withSelectFolding(@Nullable 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(@Nullable SqlWriterConfig.LineFolding lineFolding)	Sets updateSetFolding().
SqlWriterConfig	withUpdateSetListNewline(boolean updateSetListNewline)	Sets updateSetListNewline().
SqlWriterConfig	withValuesFolding(@Nullable SqlWriterConfig.LineFolding lineFolding)	Sets valuesFolding().
SqlWriterConfig	withValuesListNewline(boolean valuesListNewline)	Sets valuesListNewline().
SqlWriterConfig	withWhereFolding(@Nullable SqlWriterConfig.LineFolding lineFolding)	Sets whereFolding().
SqlWriterConfig	withWhereListItemsOnSeparateLines(boolean whereListItemsOnSeparateLines)	Sets whereListItemsOnSeparateLines().
SqlWriterConfig	withWindowDeclListNewline(boolean windowDeclListNewline)	Sets windowDeclListNewline().
SqlWriterConfig	withWindowFolding(@Nullable SqlWriterConfig.LineFolding lineFolding)	Sets windowFolding().
SqlWriterConfig	withWindowNewline(boolean windowNewline)	Sets windowNewline().

Method Details

dialect

@Nullable SqlDialect dialect()

Returns the dialect.

withDialect

SqlWriterConfig withDialect(@Nullable SqlDialect dialect)

Sets dialect().

keywordsLowerCase

@Default
default 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

@Default
default 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

@Default
default int indentation()

Returns the number of spaces indentation. Default is 4.

withIndentation

SqlWriterConfig withIndentation(int indentation)

Sets indentation().

clauseStartsLine

@Default
default 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

@Default
default 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

@Default
default 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

@Nullable 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 #selectListItemsOnSeparateLines(), #valuesListNewline(), #updateSetListNewline(), #windowDeclListNewline() are used.

withLineFolding

SqlWriterConfig withLineFolding(@Nullable SqlWriterConfig.LineFolding lineFolding)

Sets lineFolding().

selectFolding

@Nullable SqlWriterConfig.LineFolding selectFolding()

Returns the line-folding policy for the SELECT clause. If not set, the value of lineFolding() is used.

withSelectFolding

SqlWriterConfig withSelectFolding(@Nullable SqlWriterConfig.LineFolding lineFolding)

Sets selectFolding().

fromFolding

@Default
default 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

@Nullable SqlWriterConfig.LineFolding whereFolding()

Returns the line-folding policy for the WHERE clause. If not set, the value of lineFolding() is used.

withWhereFolding

SqlWriterConfig withWhereFolding(@Nullable SqlWriterConfig.LineFolding lineFolding)

Sets whereFolding().

groupByFolding

@Nullable 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(@Nullable SqlWriterConfig.LineFolding lineFolding)

Sets groupByFolding().

havingFolding

@Nullable SqlWriterConfig.LineFolding havingFolding()

Returns the line-folding policy for the HAVING clause. If not set, the value of lineFolding() is used.

withHavingFolding

SqlWriterConfig withHavingFolding(@Nullable SqlWriterConfig.LineFolding lineFolding)

Sets havingFolding().

windowFolding

@Nullable SqlWriterConfig.LineFolding windowFolding()

Returns the line-folding policy for the WINDOW clause. If not set, the value of lineFolding() is used.

withWindowFolding

SqlWriterConfig withWindowFolding(@Nullable SqlWriterConfig.LineFolding lineFolding)

Sets windowFolding().

matchFolding

@Nullable 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(@Nullable SqlWriterConfig.LineFolding lineFolding)

Sets matchFolding().

orderByFolding

@Nullable 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(@Nullable SqlWriterConfig.LineFolding lineFolding)

Sets orderByFolding().

overFolding

@Nullable 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(@Nullable SqlWriterConfig.LineFolding lineFolding)

Sets overFolding().

valuesFolding

@Nullable SqlWriterConfig.LineFolding valuesFolding()

Returns the line-folding policy for the VALUES expression. If not set, the value of lineFolding() is used.

withValuesFolding

SqlWriterConfig withValuesFolding(@Nullable SqlWriterConfig.LineFolding lineFolding)

Sets valuesFolding().

updateSetFolding

@Nullable 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(@Nullable SqlWriterConfig.LineFolding lineFolding)

Sets updateSetFolding().

selectListExtraIndentFlag

@Default
default 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

@Default
default 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

@Default
default 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

@Default
default 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

@Default
default boolean windowNewline()

Returns whether a WINDOW clause should start its own line.

withWindowNewline

SqlWriterConfig withWindowNewline(boolean windowNewline)

Sets windowNewline().

leadingComma

@Default
default 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

@Default
default SqlWriter.SubQueryStyle subQueryStyle()

Returns the sub-query style. Default is SqlWriter.SubQueryStyle.HYDE.

withSubQueryStyle

SqlWriterConfig withSubQueryStyle(SqlWriter.SubQueryStyle subQueryStyle)

Sets subQueryStyle().

whereListItemsOnSeparateLines

@Default
default 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

@Default
default boolean alwaysUseParentheses()

Returns whether expressions should always be included in parentheses. Default is false.

withAlwaysUseParentheses

SqlWriterConfig withAlwaysUseParentheses(boolean alwaysUseParentheses)

Sets alwaysUseParentheses().

lineLength

@Default
default int lineLength()

Returns the maximum line length. Default is zero, which means there is no maximum.

withLineLength

SqlWriterConfig withLineLength(int lineLength)

Sets lineLength().

foldLength

@Default
default 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

@Default
default 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().

of

static SqlWriterConfig of()

Create a default SqlWriterConfig object.

Returns:

The config.