Package org.apache.calcite.sql2rel

Class SqlToRelConverter.Blackboard

java.lang.Object

org.apache.calcite.sql2rel.SqlToRelConverter.Blackboard

All Implemented Interfaces:

SqlVisitor<RexNode>, InitializerContext, SqlRexContext

Enclosing class:

SqlToRelConverter

protected class SqlToRelConverter.Blackboard
extends Object
implements SqlRexContext, SqlVisitor<RexNode>, InitializerContext

Workspace for translating an individual SELECT statement (or sub-SELECT).

Field Summary

Fields

Modifier and Type	Field	Description
@Nullable RelNode	root
final SqlValidatorScope	scope	Collection of RelNode objects which correspond to a SELECT statement.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Blackboard(@Nullable SqlValidatorScope scope, @Nullable Map<String,RexNode> nameToNodeMap, boolean top)	Creates a Blackboard.

Method Summary

Modifier and Type	Method	Description
RexNode	convertExpression(SqlNode expr)	Converts an expression from SqlNode to RexNode format.
RexNode	convertInterval(SqlIntervalQualifier intervalQualifier)
RexNode	convertLiteral(SqlLiteral literal)	Converts a literal.
RexFieldCollation	convertSortExpression(SqlNode expr, RelFieldCollation.Direction direction, RelFieldCollation.NullDirection nullDirection)	Deprecated.
void	flatten(List<RelNode> rels, int systemFieldCount, int[] start, BiConsumer<RelNode,Integer> relOffsetList)
List<SqlMonotonicity>	getColumnMonotonicities()
int	getGroupCount()	If the operator call occurs in an aggregate query, returns the number of columns in the GROUP BY clause.
InitializerExpressionFactory	getInitializerExpressionFactory()	Returns the factory which supplies default values for INSERT, UPDATE, and NEW.
RexBuilder	getRexBuilder()	Returns the RexBuilder to use to create RexNode objects.
RexRangeRef	getSubQueryExpr(SqlCall call)	Returns the expression used to access a given IN or EXISTS sub-query.
RelDataTypeFactory	getTypeFactory()	Returns the type factory.
SqlValidator	getValidator()	Returns the validator.
@Nullable SqlNode	lookupMeasure(SqlIdentifier identifier)
RexNode	register(RelNode rel, JoinRelType joinType)
RexNode	register(RelNode rel, JoinRelType joinType, @Nullable List<RexNode> leftKeys)	Registers a relational expression.
RelNode	reRegister(RelNode root)	Re-register the registered with given root node and return the new root node.
RelNode	root()
SqlValidatorScope	scope()	Deprecated.
void	setDataset(@Nullable String datasetName)	Notifies this Blackboard that the root just set using setRoot(RelNode, boolean) was derived using dataset substitution.
void	setPatternVarRef(boolean isVarRef)
void	setRoot(RelNode root, boolean leaf)	Sets a new root relational expression, as the translation process backs its way further up the tree.
SqlNode	validateExpression(RelDataType rowType, SqlNode expr)	Validate the expression with a base table row type.
RexNode	visit(SqlCall call)	Visits a call to a SqlOperator.
RexNode	visit(SqlDataTypeSpec type)	Visits a datatype specification.
RexNode	visit(SqlDynamicParam param)	Visits a dynamic parameter.
RexNode	visit(SqlIdentifier id)	Visits an identifier.
RexNode	visit(SqlIntervalQualifier intervalQualifier)	Visits an interval qualifier.
RexNode	visit(SqlLiteral literal)	Visits a literal.
RexNode	visit(SqlNodeList nodeList)	Visits a list of SqlNode objects.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.calcite.sql2rel.InitializerContext

parseExpression

Methods inherited from interface org.apache.calcite.sql.util.SqlVisitor

visitAll, visitNode

Field Details

scope

public final SqlValidatorScope scope

Collection of RelNode objects which correspond to a SELECT statement.

root

public @Nullable RelNode root

Constructor Details

Blackboard

protected Blackboard(@Nullable SqlValidatorScope scope,
 @Nullable Map<String,RexNode> nameToNodeMap,
 boolean top)

Creates a Blackboard.

Parameters:

scope - Name-resolution scope for expressions validated within this query. Can be null if this Blackboard is for a leaf node, say

nameToNodeMap - Map which translates the expression to map a given parameter into, if translating expressions; null otherwise

top - Whether this is the root of the query

Method Details

root

public RelNode root()

scope

@Deprecated
public SqlValidatorScope scope()

Deprecated.

setPatternVarRef

public void setPatternVarRef(boolean isVarRef)

register

public RexNode register(RelNode rel,
 JoinRelType joinType)

register

public RexNode register(RelNode rel,
 JoinRelType joinType,
 @Nullable List<RexNode> leftKeys)

Registers a relational expression.

Parameters:

rel - Relational expression

joinType - Join type

leftKeys - LHS of IN clause, or null for expressions other than IN

Returns:

Expression with which to refer to the row (or partial row) coming from this relational expression's side of the join

reRegister

public RelNode reRegister(RelNode root)

Re-register the registered with given root node and return the new root node.

Parameters:

root - The given root, never leaf

Returns:

new root after the registration

setRoot

public void setRoot(RelNode root,
 boolean leaf)

Sets a new root relational expression, as the translation process backs its way further up the tree.

Parameters:

root - New root relational expression

leaf - Whether the relational expression is a leaf, that is, derived from an atomic relational expression such as a table name in the from clause, or the projection on top of a select-sub-query. In particular, relational expressions derived from JOIN operators are not leaves, but set expressions are.

setDataset

public void setDataset(@Nullable String datasetName)

Notifies this Blackboard that the root just set using setRoot(RelNode, boolean) was derived using dataset substitution.

The default implementation is not interested in such notifications, and does nothing.

Parameters:

datasetName - Dataset name

flatten

public void flatten(List<RelNode> rels,
 int systemFieldCount,
 int[] start,
 BiConsumer<RelNode,Integer> relOffsetList)

convertExpression

public RexNode convertExpression(SqlNode expr)

Description copied from interface: SqlRexContext

Converts an expression from SqlNode to RexNode format.

Specified by:

convertExpression in interface InitializerContext

Specified by:

convertExpression in interface SqlRexContext

Parameters:

expr - Expression to translate

Returns:

Converted expression

convertSortExpression

@Deprecated
public RexFieldCollation convertSortExpression(SqlNode expr,
 RelFieldCollation.Direction direction,
 RelFieldCollation.NullDirection nullDirection)

Deprecated.

Converts an item in an ORDER BY clause inside a window (OVER) clause, extracting DESC, NULLS LAST and NULLS FIRST flags first.

getGroupCount

public int getGroupCount()

Description copied from interface: SqlRexContext

If the operator call occurs in an aggregate query, returns the number of columns in the GROUP BY clause. For example, for "SELECT count(*) FROM emp GROUP BY deptno, gender", returns 2. If the operator call occurs in window aggregate query, then returns 1 if the window is guaranteed to be non-empty, or 0 if the window might be empty.

Returns 0 if the query is implicitly "GROUP BY ()" because of an aggregate expression. For example, "SELECT sum(sal) FROM emp".

Returns -1 if the query is not an aggregate query.

Specified by:

getGroupCount in interface SqlRexContext

Returns:

0 if the query is implicitly GROUP BY (), -1 if the query is not and aggregate query

See Also:

• SqlOperatorBinding.getGroupCount()

getRexBuilder

public RexBuilder getRexBuilder()

Description copied from interface: SqlRexContext

Returns the RexBuilder to use to create RexNode objects.

Specified by:

getRexBuilder in interface InitializerContext

Specified by:

getRexBuilder in interface SqlRexContext

validateExpression

public SqlNode validateExpression(RelDataType rowType,
 SqlNode expr)

Description copied from interface: InitializerContext

Validate the expression with a base table row type. The expression may reference the fields of the row type defines.

Specified by:

validateExpression in interface InitializerContext

Parameters:

rowType - the table row type

expr - the expression

Returns:

a validated SqlNode, usually it transforms from a SqlUnresolvedFunction to a resolved one

getSubQueryExpr

public RexRangeRef getSubQueryExpr(SqlCall call)

Description copied from interface: SqlRexContext

Returns the expression used to access a given IN or EXISTS sub-query.

Specified by:

getSubQueryExpr in interface SqlRexContext

Parameters:

call - IN or EXISTS expression

Returns:

Expression used to access current row of sub-query

getTypeFactory

public RelDataTypeFactory getTypeFactory()

Description copied from interface: SqlRexContext

Returns the type factory.

Specified by:

getTypeFactory in interface SqlRexContext

getInitializerExpressionFactory

public InitializerExpressionFactory getInitializerExpressionFactory()

Description copied from interface: SqlRexContext

Returns the factory which supplies default values for INSERT, UPDATE, and NEW.

Specified by:

getInitializerExpressionFactory in interface SqlRexContext

getValidator

public SqlValidator getValidator()

Description copied from interface: SqlRexContext

Returns the validator.

Specified by:

getValidator in interface SqlRexContext

convertLiteral

public RexNode convertLiteral(SqlLiteral literal)

Description copied from interface: SqlRexContext

Converts a literal.

Specified by:

convertLiteral in interface SqlRexContext

convertInterval

public RexNode convertInterval(SqlIntervalQualifier intervalQualifier)

visit

public RexNode visit(SqlLiteral literal)

Description copied from interface: SqlVisitor

Visits a literal.

Specified by:

visit in interface SqlVisitor<RexNode>

Parameters:

literal - Literal

See Also:

• SqlLiteral.accept(SqlVisitor)

visit

public RexNode visit(SqlCall call)

Description copied from interface: SqlVisitor

Visits a call to a SqlOperator.

Specified by:

visit in interface SqlVisitor<RexNode>

Parameters:

call - Call

See Also:

• SqlCall.accept(SqlVisitor)

visit

public RexNode visit(SqlNodeList nodeList)

Description copied from interface: SqlVisitor

Visits a list of SqlNode objects.

Specified by:

visit in interface SqlVisitor<RexNode>

Parameters:

nodeList - list of nodes

See Also:

• SqlNodeList.accept(SqlVisitor)

visit

public RexNode visit(SqlIdentifier id)

Description copied from interface: SqlVisitor

Visits an identifier.

Specified by:

visit in interface SqlVisitor<RexNode>

Parameters:

id - identifier

See Also:

• SqlIdentifier.accept(SqlVisitor)

visit

public RexNode visit(SqlDataTypeSpec type)

Description copied from interface: SqlVisitor

Visits a datatype specification.

Specified by:

visit in interface SqlVisitor<RexNode>

Parameters:

type - datatype specification

See Also:

• SqlDataTypeSpec.accept(SqlVisitor)

visit

public RexNode visit(SqlDynamicParam param)

Description copied from interface: SqlVisitor

Visits a dynamic parameter.

Specified by:

visit in interface SqlVisitor<RexNode>

Parameters:

param - Dynamic parameter

See Also:

• SqlDynamicParam.accept(SqlVisitor)

visit

public RexNode visit(SqlIntervalQualifier intervalQualifier)

Description copied from interface: SqlVisitor

Visits an interval qualifier.

Specified by:

visit in interface SqlVisitor<RexNode>

Parameters:

intervalQualifier - Interval qualifier

See Also:

• SqlIntervalQualifier.accept(SqlVisitor)

getColumnMonotonicities

public List<SqlMonotonicity> getColumnMonotonicities()

lookupMeasure

public @Nullable SqlNode lookupMeasure(SqlIdentifier identifier)