org.apache.calcite.sql2rel

Class SqlToRelConverter

java.lang.Object

org.apache.calcite.sql2rel.SqlToRelConverter

@Value.Enclosing
public class SqlToRelConverter
extends Object

Converts a SQL parse tree (consisting of SqlNode objects) into a relational algebra expression (consisting of RelNode objects).

The public entry points are: convertQuery(org.apache.calcite.sql.SqlNode, boolean, boolean), convertExpression(SqlNode).

FLINK modifications are at lines

1. Added in FLINK-29081, FLINK-28682, FLINK-33395: Lines 654 ~ 671
2. Added in Flink-24024: Lines 1435 ~ 1445, Lines 1459 ~ 1501
3. Added in FLINK-28682: Lines 2323 ~ 2340
4. Added in FLINK-28682: Lines 2377 ~ 2405
5. Added in FLINK-32474: Lines 2875 ~ 2887
6. Added in FLINK-32474: Lines 2987 ~ 3021
7. Added in FLINK-20873: Lines 5519 ~ 5528
8. Added in FLINK-34057, FLINK-34058: Lines 6090 ~ 6116

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	SqlToRelConverter.AggConverter Converts expressions to aggregates.
protected class	SqlToRelConverter.Blackboard Workspace for translating an individual SELECT statement (or sub-SELECT).
static interface	SqlToRelConverter.Config Interface to define the configuration for a SqlToRelConverter.
static class	SqlToRelConverter.SqlIdentifierFinder Visitor that looks for an SqlIdentifier inside a tree of SqlNode objects and return Boolean.TRUE when it finds one.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.calcite.prepare.Prepare.CatalogReader	catalogReader
protected org.apache.calcite.plan.RelOptCluster	cluster
SqlToRelConverter.Config	config
static SqlToRelConverter.Config	CONFIG Default configuration.
static int	DEFAULT_IN_SUB_QUERY_THRESHOLD Size of the smallest IN list that will be converted to a semijoin to a static table.
static int	DEFAULT_IN_SUBQUERY_THRESHOLD Deprecated.
protected Map<org.apache.calcite.rel.RelNode,Integer>	leaves
protected org.apache.calcite.rex.RexBuilder	rexBuilder
protected static org.slf4j.Logger	SQL2REL_LOGGER
protected org.apache.calcite.rel.type.RelDataTypeFactory	typeFactory
@Nullable org.apache.calcite.sql.validate.SqlValidator	validator
org.apache.calcite.plan.RelOptTable.ViewExpander	viewExpander

Constructor Summary

Constructors

Constructor and Description
SqlToRelConverter(org.apache.calcite.plan.RelOptTable.ViewExpander viewExpander, org.apache.calcite.sql.validate.SqlValidator validator, org.apache.calcite.prepare.Prepare.CatalogReader catalogReader, org.apache.calcite.plan.RelOptCluster cluster, org.apache.calcite.sql2rel.SqlRexConvertletTable convertletTable) Deprecated.
SqlToRelConverter(org.apache.calcite.plan.RelOptTable.ViewExpander viewExpander, @Nullable org.apache.calcite.sql.validate.SqlValidator validator, org.apache.calcite.prepare.Prepare.CatalogReader catalogReader, org.apache.calcite.plan.RelOptCluster cluster, org.apache.calcite.sql2rel.SqlRexConvertletTable convertletTable, SqlToRelConverter.Config config)
SqlToRelConverter(org.apache.calcite.plan.RelOptTable.ViewExpander viewExpander, org.apache.calcite.sql.validate.SqlValidator validator, org.apache.calcite.prepare.Prepare.CatalogReader catalogReader, org.apache.calcite.plan.RelOptPlanner planner, org.apache.calcite.rex.RexBuilder rexBuilder, org.apache.calcite.sql2rel.SqlRexConvertletTable convertletTable) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	addConvertedNonCorrSubqs(Map<org.apache.calcite.sql.SqlNode,org.apache.calcite.rex.RexNode> alreadyConvertedNonCorrSubqs) Adds to the current map of non-correlated converted sub-queries the elements from another map that contains non-correlated sub-queries that have been converted by another SqlToRelConverter.
protected org.apache.calcite.rex.RexNode	adjustInputRef(SqlToRelConverter.Blackboard bb, org.apache.calcite.rex.RexInputRef inputRef) Adjusts the type of a reference to an input field to account for nulls introduced by outer joins; and adjusts the offset to match the physical implementation.
protected void	afterTableFunction(SqlToRelConverter.Blackboard bb, org.apache.calcite.sql.SqlCall call, org.apache.calcite.rel.logical.LogicalTableFunctionScan callRel)
protected void	collectInsertTargets(org.apache.calcite.sql.SqlInsert call, org.apache.calcite.rex.RexNode sourceRef, List<String> targetColumnNames, List<org.apache.calcite.rex.RexNode> columnExprs) Given an INSERT statement, collects the list of names to be populated and the expressions to put in them.
static SqlToRelConverter.Config	config() Returns a default SqlToRelConverter.Config.
void	containsQueryHints() To tell this converter that this SqlNode tree contains query hints and then a query block alias will be attached to the root node of the query block.
protected void	convertAgg(SqlToRelConverter.Blackboard bb, org.apache.calcite.sql.SqlSelect select, List<org.apache.calcite.sql.SqlNode> orderExprList) Converts the SELECT, GROUP BY and HAVING clauses of an aggregate query.
protected void	convertCollectionTable(SqlToRelConverter.Blackboard bb, org.apache.calcite.sql.SqlCall call)
protected org.apache.calcite.rel.RelNode	convertColumnList(org.apache.calcite.sql.SqlInsert call, org.apache.calcite.rel.RelNode source) Creates a source for an INSERT statement.
org.apache.calcite.rex.RexDynamicParam	convertDynamicParam(org.apache.calcite.sql.SqlDynamicParam dynamicParam)
org.apache.calcite.rex.RexNode	convertExpression(org.apache.calcite.sql.SqlNode node) Converts an expression from SqlNode to RexNode format.
org.apache.calcite.rex.RexNode	convertExpression(org.apache.calcite.sql.SqlNode node, Map<String,org.apache.calcite.rex.RexNode> nameToNodeMap) Converts an expression from SqlNode to RexNode format, mapping identifier references to predefined expressions.
protected @Nullable org.apache.calcite.rex.RexNode	convertExtendedExpression(org.apache.calcite.sql.SqlNode node, SqlToRelConverter.Blackboard bb) Converts a non-standard expression.
protected void	convertFrom(SqlToRelConverter.Blackboard bb, @Nullable org.apache.calcite.sql.SqlNode from)
protected void	convertFrom(SqlToRelConverter.Blackboard bb, @Nullable org.apache.calcite.sql.SqlNode from, @Nullable List<String> fieldNames) Converts a FROM clause into a relational expression.
protected org.apache.calcite.rel.RelNode	convertInsert(org.apache.calcite.sql.SqlInsert call)
protected void	convertMatchRecognize(SqlToRelConverter.Blackboard bb, org.apache.calcite.sql.SqlMatchRecognize matchRecognize)
protected void	convertOrder(org.apache.calcite.sql.SqlSelect select, SqlToRelConverter.Blackboard bb, org.apache.calcite.rel.RelCollation collation, List<org.apache.calcite.sql.SqlNode> orderExprList, @Nullable org.apache.calcite.sql.SqlNode offset, @Nullable org.apache.calcite.sql.SqlNode fetch) Converts a query's ORDER BY clause, if any.
protected org.apache.calcite.rel.RelFieldCollation	convertOrderItem(org.apache.calcite.sql.SqlSelect select, org.apache.calcite.sql.SqlNode orderItem, List<org.apache.calcite.sql.SqlNode> extraExprs, org.apache.calcite.rel.RelFieldCollation.Direction direction, org.apache.calcite.rel.RelFieldCollation.NullDirection nullDirection)
protected void	convertPivot(SqlToRelConverter.Blackboard bb, org.apache.calcite.sql.SqlPivot pivot)
org.apache.calcite.rel.RelRoot	convertQuery(org.apache.calcite.sql.SqlNode query, boolean needsValidation, boolean top) Converts an unvalidated query's parse tree into a relational expression.
protected org.apache.calcite.rel.RelRoot	convertQueryRecursive(org.apache.calcite.sql.SqlNode query, boolean top, @Nullable org.apache.calcite.rel.type.RelDataType targetRowType) Recursively converts a query to a relational expression.
org.apache.calcite.rel.RelNode	convertSelect(org.apache.calcite.sql.SqlSelect select, boolean top) Converts a SELECT statement's parse tree into a relational expression.
protected void	convertSelectImpl(SqlToRelConverter.Blackboard bb, org.apache.calcite.sql.SqlSelect select) Implementation of convertSelect(SqlSelect, boolean); derived class may override.
protected org.apache.calcite.rel.RelNode	convertSetOp(org.apache.calcite.sql.SqlCall call) Converts a set operation (UNION, INTERSECT, MINUS) into relational expressions.
org.apache.calcite.rel.RelNode	convertToSingleValueSubq(org.apache.calcite.sql.SqlNode query, org.apache.calcite.rel.RelNode plan) Converts the RelNode tree for a select statement to a select that produces a single value.
protected void	convertUnpivot(SqlToRelConverter.Blackboard bb, org.apache.calcite.sql.SqlUnpivot unpivot)
org.apache.calcite.rel.RelNode	convertValues(org.apache.calcite.sql.SqlCall values, @Nullable org.apache.calcite.rel.type.RelDataType targetRowType) Converts a SELECT statement's parse tree into a relational expression.
org.apache.calcite.rel.RelRoot	convertWith(org.apache.calcite.sql.SqlWith with, boolean top) Converts a WITH sub-query into a relational expression.
protected void	createAggImpl(SqlToRelConverter.Blackboard bb, SqlToRelConverter.AggConverter aggConverter, org.apache.calcite.sql.SqlNodeList selectList, @Nullable org.apache.calcite.sql.SqlNodeList groupList, @Nullable org.apache.calcite.sql.SqlNode having, List<org.apache.calcite.sql.SqlNode> orderExprList)
protected org.apache.calcite.rel.RelNode	createAggregate(SqlToRelConverter.Blackboard bb, org.apache.calcite.util.ImmutableBitSet groupSet, com.google.common.collect.ImmutableList<org.apache.calcite.util.ImmutableBitSet> groupSets, List<org.apache.calcite.rel.core.AggregateCall> aggCalls) Creates an Aggregate.
protected SqlToRelConverter.Blackboard	createBlackboard(@Nullable org.apache.calcite.sql.validate.SqlValidatorScope scope, @Nullable Map<String,org.apache.calcite.rex.RexNode> nameToNodeMap, boolean top) Factory method for creating translation workspace.
protected org.apache.calcite.rel.RelNode	createJoin(SqlToRelConverter.Blackboard bb, org.apache.calcite.rel.RelNode leftRel, org.apache.calcite.rel.RelNode rightRel, org.apache.calcite.rex.RexNode joinCond, org.apache.calcite.rel.core.JoinRelType joinType)
org.apache.calcite.rel.RelNode	decorrelate(org.apache.calcite.sql.SqlNode query, org.apache.calcite.rel.RelNode rootRel) If sub-query is correlated and decorrelation is enabled, performs decorrelation.
protected org.apache.calcite.rel.RelNode	decorrelateQuery(org.apache.calcite.rel.RelNode rootRel)
protected boolean	enableDecorrelation() Deprecated.
protected void	extraSelectItems(SqlToRelConverter.Blackboard bb, org.apache.calcite.sql.SqlSelect select, List<org.apache.calcite.rex.RexNode> exprList, List<String> nameList, Collection<String> aliasList, List<org.apache.calcite.sql.validate.SqlMonotonicity> columnMonotonicityList) Adds extra select items.
org.apache.calcite.rel.RelNode	flattenTypes(org.apache.calcite.rel.RelNode rootRel, boolean restructure)
protected void	gatherOrderExprs(SqlToRelConverter.Blackboard bb, org.apache.calcite.sql.SqlSelect select, @Nullable org.apache.calcite.sql.SqlNodeList orderList, List<org.apache.calcite.sql.SqlNode> extraOrderExprs, List<org.apache.calcite.rel.RelFieldCollation> collationList) Creates a list of collations required to implement the ORDER BY clause, if there is one.
org.apache.calcite.plan.RelOptCluster	getCluster() Returns the RelOptCluster in use.
int	getDynamicParamCount() Returns the number of dynamic parameters encountered during translation; this must only be called after convertQuery(org.apache.calcite.sql.SqlNode, boolean, boolean).
int	getDynamicParamCountInExplain(boolean increment) Returns the current count of the number of dynamic parameters in an EXPLAIN PLAN statement.
org.apache.calcite.rel.type.RelDataType	getDynamicParamType(int index) Returns the type inferred for a dynamic parameter.
protected int	getInSubqueryThreshold() Deprecated.
Map<org.apache.calcite.sql.SqlNode,org.apache.calcite.rex.RexNode>	getMapConvertedNonCorrSubqs() Returns the mapping of non-correlated sub-queries that have been converted to the constants that they evaluate to.
org.apache.calcite.rex.RexBuilder	getRexBuilder() Returns the row-expression builder.
protected List<org.apache.calcite.rel.type.RelDataTypeField>	getSystemFields() Returns a list of fields to be prefixed to each relational expression.
protected org.apache.calcite.plan.RelOptTable	getTargetTable(org.apache.calcite.sql.SqlNode call)
static boolean	isOrdered(org.apache.calcite.sql.SqlNode query)
boolean	isTrimUnusedFields() Deprecated.
protected org.apache.calcite.sql2rel.RelFieldTrimmer	newFieldTrimmer() Creates a RelFieldTrimmer.
void	setDynamicParamCountInExplain(int explainParamCount) Sets the number of dynamic parameters in the current EXPLAIN PLAN statement.
void	setSubQueryConverter(org.apache.calcite.sql2rel.SubQueryConverter converter) Sets a new SubQueryConverter.
org.apache.calcite.rel.RelNode	toRel(org.apache.calcite.plan.RelOptTable table, List<org.apache.calcite.rel.hint.RelHint> hints)
org.apache.calcite.rel.RelNode	trimUnusedFields(boolean ordered, org.apache.calcite.rel.RelNode rootRel) Walks over a tree of relational expressions, replacing each RelNode with a 'slimmed down' relational expression that projects only the fields required by its consumer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONFIG

public static final SqlToRelConverter.Config CONFIG

Default configuration.

SQL2REL_LOGGER

protected static final org.slf4j.Logger SQL2REL_LOGGER

DEFAULT_IN_SUB_QUERY_THRESHOLD

public static final int DEFAULT_IN_SUB_QUERY_THRESHOLD

Size of the smallest IN list that will be converted to a semijoin to a static table.

See Also:

Constant Field Values

DEFAULT_IN_SUBQUERY_THRESHOLD

@Deprecated
public static final int DEFAULT_IN_SUBQUERY_THRESHOLD

Deprecated.

See Also:

Constant Field Values

validator

public final @Nullable org.apache.calcite.sql.validate.SqlValidator validator

rexBuilder

protected final org.apache.calcite.rex.RexBuilder rexBuilder

catalogReader

protected final org.apache.calcite.prepare.Prepare.CatalogReader catalogReader

cluster

protected final org.apache.calcite.plan.RelOptCluster cluster

leaves

protected final Map<org.apache.calcite.rel.RelNode,Integer> leaves

typeFactory

protected final org.apache.calcite.rel.type.RelDataTypeFactory typeFactory

config

public final SqlToRelConverter.Config config

viewExpander

public final org.apache.calcite.plan.RelOptTable.ViewExpander viewExpander

Constructor Detail

SqlToRelConverter

@Deprecated
public SqlToRelConverter(org.apache.calcite.plan.RelOptTable.ViewExpander viewExpander,
                                     org.apache.calcite.sql.validate.SqlValidator validator,
                                     org.apache.calcite.prepare.Prepare.CatalogReader catalogReader,
                                     org.apache.calcite.plan.RelOptPlanner planner,
                                     org.apache.calcite.rex.RexBuilder rexBuilder,
                                     org.apache.calcite.sql2rel.SqlRexConvertletTable convertletTable)

Deprecated.

Creates a converter.

Parameters:

viewExpander - Preparing statement

validator - Validator

catalogReader - Schema

planner - Planner

rexBuilder - Rex builder

convertletTable - Expression converter

SqlToRelConverter

@Deprecated
public SqlToRelConverter(org.apache.calcite.plan.RelOptTable.ViewExpander viewExpander,
                                     org.apache.calcite.sql.validate.SqlValidator validator,
                                     org.apache.calcite.prepare.Prepare.CatalogReader catalogReader,
                                     org.apache.calcite.plan.RelOptCluster cluster,
                                     org.apache.calcite.sql2rel.SqlRexConvertletTable convertletTable)

Deprecated.

SqlToRelConverter

public SqlToRelConverter(org.apache.calcite.plan.RelOptTable.ViewExpander viewExpander,
                         @Nullable org.apache.calcite.sql.validate.SqlValidator validator,
                         org.apache.calcite.prepare.Prepare.CatalogReader catalogReader,
                         org.apache.calcite.plan.RelOptCluster cluster,
                         org.apache.calcite.sql2rel.SqlRexConvertletTable convertletTable,
                         SqlToRelConverter.Config config)

Method Detail

getCluster

public org.apache.calcite.plan.RelOptCluster getCluster()

Returns the RelOptCluster in use.

getRexBuilder

public org.apache.calcite.rex.RexBuilder getRexBuilder()

Returns the row-expression builder.

getDynamicParamCount

public int getDynamicParamCount()

Returns the number of dynamic parameters encountered during translation; this must only be called after convertQuery(org.apache.calcite.sql.SqlNode, boolean, boolean).

Returns:

number of dynamic parameters

getDynamicParamType

public org.apache.calcite.rel.type.RelDataType getDynamicParamType(int index)

Returns the type inferred for a dynamic parameter.

Parameters:

index - 0-based index of dynamic parameter

Returns:

inferred type, never null

getDynamicParamCountInExplain

public int getDynamicParamCountInExplain(boolean increment)

Returns the current count of the number of dynamic parameters in an EXPLAIN PLAN statement.

Parameters:

increment - if true, increment the count

Returns:

the current count before the optional increment

getMapConvertedNonCorrSubqs

public Map<org.apache.calcite.sql.SqlNode,org.apache.calcite.rex.RexNode> getMapConvertedNonCorrSubqs()

Returns the mapping of non-correlated sub-queries that have been converted to the constants that they evaluate to.

addConvertedNonCorrSubqs

public void addConvertedNonCorrSubqs(Map<org.apache.calcite.sql.SqlNode,org.apache.calcite.rex.RexNode> alreadyConvertedNonCorrSubqs)

Adds to the current map of non-correlated converted sub-queries the elements from another map that contains non-correlated sub-queries that have been converted by another SqlToRelConverter.

Parameters:

alreadyConvertedNonCorrSubqs - the other map

setSubQueryConverter

public void setSubQueryConverter(org.apache.calcite.sql2rel.SubQueryConverter converter)

Sets a new SubQueryConverter. To have any effect, this must be called before any convert method.

Parameters:

converter - new SubQueryConverter

setDynamicParamCountInExplain

public void setDynamicParamCountInExplain(int explainParamCount)

Sets the number of dynamic parameters in the current EXPLAIN PLAN statement.

Parameters:

explainParamCount - number of dynamic parameters in the statement

flattenTypes

public org.apache.calcite.rel.RelNode flattenTypes(org.apache.calcite.rel.RelNode rootRel,
                                                   boolean restructure)

decorrelate

public org.apache.calcite.rel.RelNode decorrelate(org.apache.calcite.sql.SqlNode query,
                                                  org.apache.calcite.rel.RelNode rootRel)

If sub-query is correlated and decorrelation is enabled, performs decorrelation.

Parameters:

query - Query

rootRel - Root relational expression

Returns:

New root relational expression after decorrelation

trimUnusedFields

public org.apache.calcite.rel.RelNode trimUnusedFields(boolean ordered,
                                                       org.apache.calcite.rel.RelNode rootRel)

Walks over a tree of relational expressions, replacing each RelNode with a 'slimmed down' relational expression that projects only the fields required by its consumer.

This may make things easier for the optimizer, by removing crud that would expand the search space, but is difficult for the optimizer itself to do it, because optimizer rules must preserve the number and type of fields. Hence, this transform that operates on the entire tree, similar to the type-flattening transform.

Currently this functionality is disabled in farrago/luciddb; the default implementation of this method does nothing.

Parameters:

ordered - Whether the relational expression must produce results in a particular order (typically because it has an ORDER BY at top level)

rootRel - Relational expression that is at the root of the tree

Returns:

Trimmed relational expression

newFieldTrimmer

protected org.apache.calcite.sql2rel.RelFieldTrimmer newFieldTrimmer()

Creates a RelFieldTrimmer.

Returns:

Field trimmer

convertQuery

public org.apache.calcite.rel.RelRoot convertQuery(org.apache.calcite.sql.SqlNode query,
                                                   boolean needsValidation,
                                                   boolean top)

Converts an unvalidated query's parse tree into a relational expression.

Parameters:

query - Query to convert

needsValidation - Whether to validate the query before converting; false if the query has already been validated.

top - Whether the query is top-level, say if its result will become a JDBC result set; false if the query will be part of a view.

isOrdered

public static boolean isOrdered(org.apache.calcite.sql.SqlNode query)

convertSelect

public org.apache.calcite.rel.RelNode convertSelect(org.apache.calcite.sql.SqlSelect select,
                                                    boolean top)

Converts a SELECT statement's parse tree into a relational expression.

createBlackboard

protected SqlToRelConverter.Blackboard createBlackboard(@Nullable org.apache.calcite.sql.validate.SqlValidatorScope scope,
                                                        @Nullable Map<String,org.apache.calcite.rex.RexNode> nameToNodeMap,
                                                        boolean top)

Factory method for creating translation workspace.

convertSelectImpl

protected void convertSelectImpl(SqlToRelConverter.Blackboard bb,
                                 org.apache.calcite.sql.SqlSelect select)

Implementation of convertSelect(SqlSelect, boolean); derived class may override.

convertOrder

protected void convertOrder(org.apache.calcite.sql.SqlSelect select,
                            SqlToRelConverter.Blackboard bb,
                            org.apache.calcite.rel.RelCollation collation,
                            List<org.apache.calcite.sql.SqlNode> orderExprList,
                            @Nullable org.apache.calcite.sql.SqlNode offset,
                            @Nullable org.apache.calcite.sql.SqlNode fetch)

Converts a query's ORDER BY clause, if any.

Ignores the ORDER BY clause if the query is not top-level and FETCH or OFFSET are not present.

Parameters:

select - Query

bb - Blackboard

collation - Collation list

orderExprList - Method populates this list with orderBy expressions not present in selectList

offset - Expression for number of rows to discard before returning first row

fetch - Expression for number of rows to fetch

convertToSingleValueSubq

public org.apache.calcite.rel.RelNode convertToSingleValueSubq(org.apache.calcite.sql.SqlNode query,
                                                               org.apache.calcite.rel.RelNode plan)

Converts the RelNode tree for a select statement to a select that produces a single value.

Parameters:

query - the query

plan - the original RelNode tree corresponding to the statement

Returns:

the converted RelNode tree

getInSubqueryThreshold

@Deprecated
protected int getInSubqueryThreshold()

Deprecated.

Gets the list size threshold under which 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

Returns:

threshold, default DEFAULT_IN_SUB_QUERY_THRESHOLD

convertExpression

public org.apache.calcite.rex.RexNode convertExpression(org.apache.calcite.sql.SqlNode node)

Converts an expression from SqlNode to RexNode format.

Parameters:

node - Expression to translate

Returns:

Converted expression

convertExpression

public org.apache.calcite.rex.RexNode convertExpression(org.apache.calcite.sql.SqlNode node,
                                                        Map<String,org.apache.calcite.rex.RexNode> nameToNodeMap)

Converts an expression from SqlNode to RexNode format, mapping identifier references to predefined expressions.

Parameters:

node - Expression to translate

nameToNodeMap - map from String to RexNode; when an SqlIdentifier is encountered, it is used as a key and translated to the corresponding value from this map

Returns:

Converted expression

convertExtendedExpression

protected @Nullable org.apache.calcite.rex.RexNode convertExtendedExpression(org.apache.calcite.sql.SqlNode node,
                                                                             SqlToRelConverter.Blackboard bb)

Converts a non-standard expression.

This method is an extension-point that derived classes can override. If this method returns a null result, the normal expression translation process will proceed. The default implementation always returns null.

Parameters:

node - Expression

bb - Blackboard

Returns:

null to proceed with the usual expression translation process

convertFrom

protected void convertFrom(SqlToRelConverter.Blackboard bb,
                           @Nullable org.apache.calcite.sql.SqlNode from)

containsQueryHints

public void containsQueryHints()

To tell this converter that this SqlNode tree contains query hints and then a query block alias will be attached to the root node of the query block.

The `containsQueryHints` is false default to be compatible with previous behavior and then planner can reuse some node.

TODO At present, it is a relatively hacked way

convertFrom

protected void convertFrom(SqlToRelConverter.Blackboard bb,
                           @Nullable org.apache.calcite.sql.SqlNode from,
                           @Nullable List<String> fieldNames)

Converts a FROM clause into a relational expression.

Parameters:

bb - Scope within which to resolve identifiers

from - FROM clause of a query. Examples include:

• a single table ("SALES.EMP"),
• an aliased table ("EMP AS E"),
• a list of tables ("EMP, DEPT"),
• an ANSI Join expression ("EMP JOIN DEPT ON EMP.DEPTNO = DEPT.DEPTNO"),
• a VALUES clause ("VALUES ('Fred', 20)"),
• a query ("(SELECT * FROM EMP WHERE GENDER = 'F')"),
• or any combination of the above.

fieldNames - Field aliases, usually come from AS clause, or null

convertMatchRecognize

protected void convertMatchRecognize(SqlToRelConverter.Blackboard bb,
                                     org.apache.calcite.sql.SqlMatchRecognize matchRecognize)

convertPivot

protected void convertPivot(SqlToRelConverter.Blackboard bb,
                            org.apache.calcite.sql.SqlPivot pivot)

convertUnpivot

protected void convertUnpivot(SqlToRelConverter.Blackboard bb,
                              org.apache.calcite.sql.SqlUnpivot unpivot)

convertCollectionTable

protected void convertCollectionTable(SqlToRelConverter.Blackboard bb,
                                      org.apache.calcite.sql.SqlCall call)

afterTableFunction

protected void afterTableFunction(SqlToRelConverter.Blackboard bb,
                                  org.apache.calcite.sql.SqlCall call,
                                  org.apache.calcite.rel.logical.LogicalTableFunctionScan callRel)

createJoin

protected org.apache.calcite.rel.RelNode createJoin(SqlToRelConverter.Blackboard bb,
                                                    org.apache.calcite.rel.RelNode leftRel,
                                                    org.apache.calcite.rel.RelNode rightRel,
                                                    org.apache.calcite.rex.RexNode joinCond,
                                                    org.apache.calcite.rel.core.JoinRelType joinType)

getSystemFields

protected List<org.apache.calcite.rel.type.RelDataTypeField> getSystemFields()

Returns a list of fields to be prefixed to each relational expression.

Returns:

List of system fields

convertAgg

protected void convertAgg(SqlToRelConverter.Blackboard bb,
                          org.apache.calcite.sql.SqlSelect select,
                          List<org.apache.calcite.sql.SqlNode> orderExprList)

Converts the SELECT, GROUP BY and HAVING clauses of an aggregate query.

This method extracts SELECT, GROUP BY and HAVING clauses, and creates an SqlToRelConverter.AggConverter, then delegates to createAggImpl(org.apache.calcite.sql2rel.SqlToRelConverter.Blackboard, org.apache.calcite.sql2rel.SqlToRelConverter.AggConverter, org.apache.calcite.sql.SqlNodeList, org.apache.calcite.sql.SqlNodeList, org.apache.calcite.sql.SqlNode, java.util.List<org.apache.calcite.sql.SqlNode>). Derived class may override this method to change any of those clauses or specify a different SqlToRelConverter.AggConverter.

Parameters:

bb - Scope within which to resolve identifiers

select - Query

orderExprList - Additional expressions needed to implement ORDER BY

createAggImpl

protected final void createAggImpl(SqlToRelConverter.Blackboard bb,
                                   SqlToRelConverter.AggConverter aggConverter,
                                   org.apache.calcite.sql.SqlNodeList selectList,
                                   @Nullable org.apache.calcite.sql.SqlNodeList groupList,
                                   @Nullable org.apache.calcite.sql.SqlNode having,
                                   List<org.apache.calcite.sql.SqlNode> orderExprList)

createAggregate

protected org.apache.calcite.rel.RelNode createAggregate(SqlToRelConverter.Blackboard bb,
                                                         org.apache.calcite.util.ImmutableBitSet groupSet,
                                                         com.google.common.collect.ImmutableList<org.apache.calcite.util.ImmutableBitSet> groupSets,
                                                         List<org.apache.calcite.rel.core.AggregateCall> aggCalls)

Creates an Aggregate.

In case the aggregate rel changes the order in which it projects fields, the groupExprProjection parameter is provided, and the implementation of this method may modify it.

The sortedCount parameter is the number of expressions known to be monotonic. These expressions must be on the leading edge of the grouping keys. The default implementation of this method ignores this parameter.

Parameters:

bb - Blackboard

groupSet - Bit set of ordinals of grouping columns

groupSets - Grouping sets

aggCalls - Array of calls to aggregate functions

Returns:

LogicalAggregate

convertDynamicParam

public org.apache.calcite.rex.RexDynamicParam convertDynamicParam(org.apache.calcite.sql.SqlDynamicParam dynamicParam)

gatherOrderExprs

protected void gatherOrderExprs(SqlToRelConverter.Blackboard bb,
                                org.apache.calcite.sql.SqlSelect select,
                                @Nullable org.apache.calcite.sql.SqlNodeList orderList,
                                List<org.apache.calcite.sql.SqlNode> extraOrderExprs,
                                List<org.apache.calcite.rel.RelFieldCollation> collationList)

Creates a list of collations required to implement the ORDER BY clause, if there is one. Populates extraOrderExprs with any sort expressions which are not in the select clause.

Parameters:

bb - Scope within which to resolve identifiers

select - Select clause. Never null, because we invent a dummy SELECT if ORDER BY is applied to a set operation (UNION etc.)

orderList - Order by clause, may be null

extraOrderExprs - Sort expressions which are not in the select clause (output)

collationList - List of collations (output)

convertOrderItem

protected org.apache.calcite.rel.RelFieldCollation convertOrderItem(org.apache.calcite.sql.SqlSelect select,
                                                                    org.apache.calcite.sql.SqlNode orderItem,
                                                                    List<org.apache.calcite.sql.SqlNode> extraExprs,
                                                                    org.apache.calcite.rel.RelFieldCollation.Direction direction,
                                                                    org.apache.calcite.rel.RelFieldCollation.NullDirection nullDirection)

enableDecorrelation

@Deprecated
protected boolean enableDecorrelation()

Deprecated.

decorrelateQuery

protected org.apache.calcite.rel.RelNode decorrelateQuery(org.apache.calcite.rel.RelNode rootRel)

isTrimUnusedFields

@Deprecated
public boolean isTrimUnusedFields()

Deprecated.

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

Returns:

Whether to trim unused fields

convertQueryRecursive

protected org.apache.calcite.rel.RelRoot convertQueryRecursive(org.apache.calcite.sql.SqlNode query,
                                                               boolean top,
                                                               @Nullable org.apache.calcite.rel.type.RelDataType targetRowType)

Recursively converts a query to a relational expression.

Parameters:

query - Query

top - Whether this query is the top-level query of the statement

targetRowType - Target row type, or null

Returns:

Relational expression

convertSetOp

protected org.apache.calcite.rel.RelNode convertSetOp(org.apache.calcite.sql.SqlCall call)

Converts a set operation (UNION, INTERSECT, MINUS) into relational expressions.

Parameters:

call - Call to set operator

Returns:

Relational expression

convertInsert

protected org.apache.calcite.rel.RelNode convertInsert(org.apache.calcite.sql.SqlInsert call)

toRel

public org.apache.calcite.rel.RelNode toRel(org.apache.calcite.plan.RelOptTable table,
                                            List<org.apache.calcite.rel.hint.RelHint> hints)

getTargetTable

protected org.apache.calcite.plan.RelOptTable getTargetTable(org.apache.calcite.sql.SqlNode call)

convertColumnList

protected org.apache.calcite.rel.RelNode convertColumnList(org.apache.calcite.sql.SqlInsert call,
                                                           org.apache.calcite.rel.RelNode source)

Creates a source for an INSERT statement.

If the column list is not specified, source expressions match target columns in order.

If the column list is specified, Source expressions are mapped to target columns by name via targetColumnList, and may not cover the entire target table. So, we'll make up a full row, using a combination of default values and the source expressions provided.

Parameters:

call - Insert expression

source - Source relational expression

Returns:

Converted INSERT statement

collectInsertTargets

protected void collectInsertTargets(org.apache.calcite.sql.SqlInsert call,
                                    org.apache.calcite.rex.RexNode sourceRef,
                                    List<String> targetColumnNames,
                                    List<org.apache.calcite.rex.RexNode> columnExprs)

Given an INSERT statement, collects the list of names to be populated and the expressions to put in them.

Parameters:

call - Insert statement

sourceRef - Expression representing a row from the source relational expression

targetColumnNames - List of target column names, to be populated

columnExprs - List of expressions, to be populated

adjustInputRef

protected org.apache.calcite.rex.RexNode adjustInputRef(SqlToRelConverter.Blackboard bb,
                                                        org.apache.calcite.rex.RexInputRef inputRef)

Adjusts the type of a reference to an input field to account for nulls introduced by outer joins; and adjusts the offset to match the physical implementation.

Parameters:

bb - Blackboard

inputRef - Input ref

Returns:

Adjusted input ref

extraSelectItems

protected void extraSelectItems(SqlToRelConverter.Blackboard bb,
                                org.apache.calcite.sql.SqlSelect select,
                                List<org.apache.calcite.rex.RexNode> exprList,
                                List<String> nameList,
                                Collection<String> aliasList,
                                List<org.apache.calcite.sql.validate.SqlMonotonicity> columnMonotonicityList)

Adds extra select items. The default implementation adds nothing; derived classes may add columns to exprList, nameList, aliasList and columnMonotonicityList.

Parameters:

bb - Blackboard

select - Select statement being translated

exprList - List of expressions in select clause

nameList - List of names, one per column

aliasList - Collection of aliases that have been used already

columnMonotonicityList - List of monotonicity, one per column

convertWith

public org.apache.calcite.rel.RelRoot convertWith(org.apache.calcite.sql.SqlWith with,
                                                  boolean top)

Converts a WITH sub-query into a relational expression.

convertValues

public org.apache.calcite.rel.RelNode convertValues(org.apache.calcite.sql.SqlCall values,
                                                    @Nullable org.apache.calcite.rel.type.RelDataType targetRowType)

Converts a SELECT statement's parse tree into a relational expression.

config

public static SqlToRelConverter.Config config()

Returns a default SqlToRelConverter.Config.