org.apache.calcite.sql2rel

Interface SqlToRelConverter.Config

Enclosing class:

SqlToRelConverter

public static interface SqlToRelConverter.Config

Interface to define the configuration for a SqlToRelConverter. Provides methods to set each configuration option.

See Also:

SqlToRelConverter.CONFIG

Method Summary

Modifier and Type	Method and Description
default SqlToRelConverter.Config	addRelBuilderConfigTransform(java.util.function.UnaryOperator<org.apache.calcite.tools.RelBuilder.Config> transform) Adds a transform to getRelBuilderConfigTransform().
org.apache.calcite.rel.hint.HintStrategyTable	getHintStrategyTable() Returns the hint strategies used to decide how the hints are propagated to the relational expressions.
int	getInSubQueryThreshold() Returns the inSubQueryThreshold option, default SqlToRelConverter.DEFAULT_IN_SUB_QUERY_THRESHOLD.
java.util.function.UnaryOperator<org.apache.calcite.tools.RelBuilder.Config>	getRelBuilderConfigTransform() Returns a function that takes a RelBuilder.Config and returns another.
org.apache.calcite.tools.RelBuilderFactory	getRelBuilderFactory() Returns the factory to create RelBuilder, never null.
boolean	isCreateValuesRel() Returns the createValuesRel option.
boolean	isDecorrelationEnabled() Returns the decorrelationEnabled option.
boolean	isExpand() Returns the expand option.
boolean	isExplain() Returns the explain option.
boolean	isRemoveSortInSubQuery() Returns whether to remove Sort operator for a sub-query if the Sort has no offset and fetch limit attributes.
boolean	isTrimUnusedFields() Returns the trimUnusedFields option.
SqlToRelConverter.Config	withCreateValuesRel(boolean createValuesRel) Sets isCreateValuesRel().
SqlToRelConverter.Config	withDecorrelationEnabled(boolean decorrelationEnabled) Sets isDecorrelationEnabled().
SqlToRelConverter.Config	withExpand(boolean expand) Sets isExpand().
SqlToRelConverter.Config	withExplain(boolean explain) Sets isExplain().
SqlToRelConverter.Config	withHintStrategyTable(org.apache.calcite.rel.hint.HintStrategyTable hintStrategyTable) Sets getHintStrategyTable().
SqlToRelConverter.Config	withInSubQueryThreshold(int threshold) Sets getInSubQueryThreshold().
SqlToRelConverter.Config	withRelBuilderConfigTransform(java.util.function.UnaryOperator<org.apache.calcite.tools.RelBuilder.Config> transform) Sets getRelBuilderConfigTransform().
SqlToRelConverter.Config	withRelBuilderFactory(org.apache.calcite.tools.RelBuilderFactory factory) Sets getRelBuilderFactory().
SqlToRelConverter.Config	withRemoveSortInSubQuery(boolean removeSortInSubQuery) Sets isRemoveSortInSubQuery().
SqlToRelConverter.Config	withTrimUnusedFields(boolean trimUnusedFields) Sets isTrimUnusedFields().

Method Detail

isDecorrelationEnabled

boolean isDecorrelationEnabled()

Returns the decorrelationEnabled option. Controls whether to disable sub-query decorrelation when needed. e.g. if outer joins are not supported.

withDecorrelationEnabled

SqlToRelConverter.Config withDecorrelationEnabled(boolean decorrelationEnabled)

Sets isDecorrelationEnabled().

isTrimUnusedFields

boolean isTrimUnusedFields()

Returns the trimUnusedFields option. Controls whether to trim unused fields as part of the conversion process.

withTrimUnusedFields

SqlToRelConverter.Config withTrimUnusedFields(boolean trimUnusedFields)

Sets isTrimUnusedFields().

isCreateValuesRel

boolean isCreateValuesRel()

Returns the createValuesRel option. Controls whether instances of LogicalValues are generated. These may not be supported by all physical implementations.

withCreateValuesRel

SqlToRelConverter.Config withCreateValuesRel(boolean createValuesRel)

Sets isCreateValuesRel().

isExplain

boolean isExplain()

Returns the explain option. Describes whether the current statement is part of an EXPLAIN PLAN statement.

withExplain

SqlToRelConverter.Config withExplain(boolean explain)

Sets isExplain().

isExpand

boolean isExpand()

Returns the expand option. Controls whether to expand sub-queries. If false, each sub-query becomes a RexSubQuery.

withExpand

SqlToRelConverter.Config withExpand(boolean expand)

Sets isExpand().

getInSubQueryThreshold

int getInSubQueryThreshold()

Returns the inSubQueryThreshold option, default SqlToRelConverter.DEFAULT_IN_SUB_QUERY_THRESHOLD. Controls the list size threshold under which SqlToRelConverter.convertInToOr(org.apache.calcite.sql2rel.SqlToRelConverter.Blackboard, java.util.List<org.apache.calcite.rex.RexNode>, org.apache.calcite.sql.SqlNodeList, org.apache.calcite.sql.fun.SqlInOperator) is used. Lists of this size or greater will instead be converted to use a join against an inline table (LogicalValues) rather than a predicate. A threshold of 0 forces usage of an inline table in all cases; a threshold of Integer.MAX_VALUE forces usage of OR in all cases.

withInSubQueryThreshold

SqlToRelConverter.Config withInSubQueryThreshold(int threshold)

Sets getInSubQueryThreshold().

isRemoveSortInSubQuery

boolean isRemoveSortInSubQuery()

Returns whether to remove Sort operator for a sub-query if the Sort has no offset and fetch limit attributes. Because the remove does not change the semantics, in many cases this is a promotion. Default is true.

withRemoveSortInSubQuery

SqlToRelConverter.Config withRemoveSortInSubQuery(boolean removeSortInSubQuery)

Sets isRemoveSortInSubQuery().

getRelBuilderFactory

org.apache.calcite.tools.RelBuilderFactory getRelBuilderFactory()

Returns the factory to create RelBuilder, never null. Default is RelFactories.LOGICAL_BUILDER.

withRelBuilderFactory

SqlToRelConverter.Config withRelBuilderFactory(org.apache.calcite.tools.RelBuilderFactory factory)

Sets getRelBuilderFactory().

getRelBuilderConfigTransform

java.util.function.UnaryOperator<org.apache.calcite.tools.RelBuilder.Config> getRelBuilderConfigTransform()

Returns a function that takes a RelBuilder.Config and returns another. Default is the identity function.

withRelBuilderConfigTransform

SqlToRelConverter.Config withRelBuilderConfigTransform(java.util.function.UnaryOperator<org.apache.calcite.tools.RelBuilder.Config> transform)

Sets getRelBuilderConfigTransform().

See Also:

addRelBuilderConfigTransform(java.util.function.UnaryOperator<org.apache.calcite.tools.RelBuilder.Config>)

addRelBuilderConfigTransform

default SqlToRelConverter.Config addRelBuilderConfigTransform(java.util.function.UnaryOperator<org.apache.calcite.tools.RelBuilder.Config> transform)

Adds a transform to getRelBuilderConfigTransform().

getHintStrategyTable

org.apache.calcite.rel.hint.HintStrategyTable getHintStrategyTable()

Returns the hint strategies used to decide how the hints are propagated to the relational expressions. Default is HintStrategyTable.EMPTY.

withHintStrategyTable

SqlToRelConverter.Config withHintStrategyTable(org.apache.calcite.rel.hint.HintStrategyTable hintStrategyTable)

Sets getHintStrategyTable().