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 and Description
(package private) SqlToRelConverter.AggConverter	agg Workspace for building aggregates.
private List<SqlMonotonicity>	columnMonotonicities
(package private) List<RelNode>	cursors
private InitializerExpressionFactory	initializerExpressionFactory
private List<RelNode>	inputs
private boolean	isPatternVarRef
private Map<CorrelationId,RexFieldAccess>	mapCorrelateToRex
private Map<RelNode,Map<Integer,Integer>>	mapRootRelToFieldProjection Project the groupby expressions out of the root of this sub-select.
private Map<String,RexNode>	nameToNodeMap
RelNode	root
SqlValidatorScope	scope Collection of RelNode objects which correspond to a SELECT statement.
private Set<SqlToRelConverter.SubQuery>	subQueryList List of IN and EXISTS nodes inside this SELECT statement (but not inside sub-queries).
private List<RelDataTypeField>	systemFieldList
(package private) boolean	top
(package private) SqlWindow	window When converting window aggregate, we need to know if the window is guaranteed to be non-empty.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
RexNode	convertExpression(SqlNode expr) Converts an expression from SqlNode to RexNode format.
RexNode	convertInterval(SqlIntervalQualifier intervalQualifier)
RexNode	convertLiteral(SqlLiteral literal) Converts a literal.
RexNode	convertSortExpression(SqlNode expr, Set<SqlKind> flags) Converts an item in an ORDER BY clause, extracting DESC, NULLS LAST and NULLS FIRST flags first.
void	flatten(List<RelNode> rels, int systemFieldCount, int[] start, List<Pair<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.
(package private) RelDataTypeField	getRootField(RexInputRef inputRef)
(package private) SqlToRelConverter.SubQuery	getSubQuery(SqlNode expr)
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.
private boolean	isConvertedSubq(RexNode rex) Determines whether a RexNode corresponds to a sub-query that's been converted to a constant.
(package private) RexNode	lookup(int offset, SqlToRelConverter.LookupContext lookupContext) Creates an expression with which to reference the expression whose offset in its from-list is offset.
(package private) Pair<RexNode,Map<String,Integer>>	lookupExp(SqlQualified qualified) Returns an expression with which to reference a from-list item.
RexNode	register(RelNode rel, JoinRelType joinType)
RexNode	register(RelNode rel, JoinRelType joinType, List<RexNode> leftKeys) Registers a relational expression.
(package private) void	registerSubQuery(SqlNode node, RelOptUtil.Logic logic)
(package private) com.google.common.collect.ImmutableList<RelNode>	retrieveCursors()
void	setDataset(String datasetName) Notifies this Blackboard that the root just set using setRoot(RelNode, boolean) was derived using dataset substitution.
void	setPatternVarRef(boolean isVarRef)
(package private) void	setRoot(List<RelNode> inputs)
private void	setRoot(List<RelNode> inputs, RelNode root, boolean hasSystemFields)
void	setRoot(RelNode root, boolean leaf) Sets a new root relational expression, as the translation process backs its way further up the tree.
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

Field Detail

scope

public final SqlValidatorScope scope

Collection of RelNode objects which correspond to a SELECT statement.

nameToNodeMap

private final Map<String,RexNode> nameToNodeMap

root

public RelNode root

inputs

private List<RelNode> inputs

mapCorrelateToRex

private final Map<CorrelationId,RexFieldAccess> mapCorrelateToRex

isPatternVarRef

private boolean isPatternVarRef

cursors

final List<RelNode> cursors

subQueryList

private final Set<SqlToRelConverter.SubQuery> subQueryList

List of IN and EXISTS nodes inside this SELECT statement (but not inside sub-queries).

agg

SqlToRelConverter.AggConverter agg

Workspace for building aggregates.

window

SqlWindow window

When converting window aggregate, we need to know if the window is guaranteed to be non-empty.

mapRootRelToFieldProjection

private final Map<RelNode,Map<Integer,Integer>> mapRootRelToFieldProjection

Project the groupby expressions out of the root of this sub-select. Sub-queries can reference group by expressions projected from the "right" to the sub-query.

columnMonotonicities

private final List<SqlMonotonicity> columnMonotonicities

systemFieldList

private final List<RelDataTypeField> systemFieldList

top

final boolean top

initializerExpressionFactory

private final InitializerExpressionFactory initializerExpressionFactory

Constructor Detail

Blackboard

protected Blackboard(SqlValidatorScope scope,
                     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 Detail

setPatternVarRef

public void setPatternVarRef(boolean isVarRef)

register

public RexNode register(RelNode rel,
                        JoinRelType joinType)

register

public RexNode register(RelNode rel,
                        JoinRelType joinType,
                        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

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.

setRoot

private void setRoot(List<RelNode> inputs,
                     RelNode root,
                     boolean hasSystemFields)

setDataset

public void setDataset(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

setRoot

void setRoot(List<RelNode> inputs)

lookupExp

Pair<RexNode,Map<String,Integer>> lookupExp(SqlQualified qualified)

Returns an expression with which to reference a from-list item.

Parameters:

qualified - the alias of the from item

Returns:

a RexFieldAccess or RexRangeRef, or null if not found

lookup

RexNode lookup(int offset,
               SqlToRelConverter.LookupContext lookupContext)

Creates an expression with which to reference the expression whose offset in its from-list is offset.

getRootField

RelDataTypeField getRootField(RexInputRef inputRef)

flatten

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

registerSubQuery

void registerSubQuery(SqlNode node,
                      RelOptUtil.Logic logic)

getSubQuery

SqlToRelConverter.SubQuery getSubQuery(SqlNode expr)

retrieveCursors

com.google.common.collect.ImmutableList<RelNode> retrieveCursors()

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

public RexNode convertSortExpression(SqlNode expr,
                                     Set<SqlKind> flags)

Converts an item in an ORDER BY clause, extracting DESC, NULLS LAST and NULLS FIRST flags first.

isConvertedSubq

private boolean isConvertedSubq(RexNode rex)

Determines whether a RexNode corresponds to a sub-query that's been converted to a constant.

Parameters:

rex - the expression to be examined

Returns:

true if the expression is a dynamic parameter, a literal, or a literal that is being cast

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

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()