Inheritance diagram for org.apache.calcite.sql2rel.SqlToRelConverter.Blackboard:

Collaboration diagram for org.apache.calcite.sql2rel.SqlToRelConverter.Blackboard:

Public Member Functions
SqlNode	getTopNode ()

void	setPatternVarRef (boolean isVarRef)

RexNode	register (RelNode rel, JoinRelType joinType)

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

void	setRoot (RelNode root, boolean leaf)

void	setDataset (String datasetName)

Public Attributes
final SqlValidatorScope	scope

RelNode	root

Protected Member Functions
	Blackboard (SqlValidatorScope scope, Map< String, RexNode > nameToNodeMap, boolean top)

Package Functions
void	setRoot (List< RelNode > inputs)

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

Package Attributes
final List< RelNode >	cursors = new ArrayList<>()

AggConverter	agg

SqlWindow	window

final boolean	top

Private Member Functions
void	setRoot (List< RelNode > inputs, RelNode root, boolean hasSystemFields)

Private Attributes
final Map< String, RexNode >	nameToNodeMap

List< RelNode >	inputs

final Map< CorrelationId, RexFieldAccess >	mapCorrelateToRex = new HashMap<>()

boolean	isPatternVarRef = false

final List< SubQuery >	subQueryList = new ArrayList<>()

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

final List< SqlMonotonicity >	columnMonotonicities = new ArrayList<>()

final List< RelDataTypeField >	systemFieldList = new ArrayList<>()

final InitializerExpressionFactory	initializerExpressionFactory

Detailed Description

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

Definition at line 4101 of file SqlToRelConverter.java.

Constructor & Destructor Documentation

◆ Blackboard()

org.apache.calcite.sql2rel.SqlToRelConverter.Blackboard.Blackboard	(	SqlValidatorScope	scope,
		Map< String, RexNode >	nameToNodeMap,
		boolean	top
	)

inlineprotected

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

Definition at line 4160 of file SqlToRelConverter.java.

                                                                                       {
       this.scope = scope;
       this.nameToNodeMap = nameToNodeMap;
       this.top = top;
     }

Member Function Documentation

◆ getTopNode()

SqlNode org.apache.calcite.sql2rel.SqlToRelConverter.Blackboard.getTopNode ( )

inline

Definition at line 4167 of file SqlToRelConverter.java.

Referenced by org.apache.calcite.sql2rel.SqlToRelConverter.createJoin(), and org.apache.calcite.sql2rel.SqlToRelConverter.substituteSubQuery().

                                 {
       try {
         if (null == scope) {
           return null;
         }
         return scope.getNode();
       } catch (Exception e) {
         return null;
       }
     }

Here is the caller graph for this function:

◆ lookupExp()

Pair<RexNode, Map<String, Integer> > org.apache.calcite.sql2rel.SqlToRelConverter.Blackboard.lookupExp ( SqlQualified qualified )

inlinepackage

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

Definition at line 4323 of file SqlToRelConverter.java.

Referenced by org.apache.calcite.sql2rel.SqlToRelConverter.convertIdentifier().

                                                                           {
       if (nameToNodeMap != null && qualified.prefixLength == 1) {
         RexNode node = nameToNodeMap.get(qualified.identifier.names.get(0));
         if (node == null) {
           throw new AssertionError("Unknown identifier '" + qualified.identifier
                   + "' encountered while expanding expression");
         }
         return Pair.of(node, null);
       }
       final SqlNameMatcher nameMatcher =
               scope.getValidator().getCatalogReader().nameMatcher();
       final SqlValidatorScope.ResolvedImpl resolved =
               new SqlValidatorScope.ResolvedImpl();
       scope.resolve(qualified.prefix(), nameMatcher, false, resolved);
       if (!(resolved.count() == 1)) {
         return null;
       }
       final SqlValidatorScope.Resolve resolve = resolved.only();
       final RelDataType rowType = resolve.rowType();
 
       // Found in current query's from list. Find which from item.
       // We assume that the order of the from clause items has been
       // preserved.
       final SqlValidatorScope ancestorScope = resolve.scope;
       boolean isParent = ancestorScope != scope;
       if ((inputs != null) && !isParent) {
         final LookupContext rels =
                 new LookupContext(this, inputs, systemFieldList.size());
         final RexNode node = lookup(resolve.path.steps().get(0).i, rels);
         if (node == null) {
           return null;
         } else {
           final Map<String, Integer> fieldOffsets = new HashMap<>();
           for (RelDataTypeField f : resolve.rowType().getFieldList()) {
             if (!fieldOffsets.containsKey(f.getName())) {
               fieldOffsets.put(f.getName(), f.getIndex());
             }
           }
           final Map<String, Integer> map = ImmutableMap.copyOf(fieldOffsets);
           return Pair.of(node, map);
         }
       } else {
         // We're referencing a relational expression which has not been
         // converted yet. This occurs when from items are correlated,
         // e.g. "select from emp as emp join emp.getDepts() as dept".
         // Create a temporary expression.
         DeferredLookup lookup =
                 new DeferredLookup(this, qualified.identifier.names.get(0));
         final CorrelationId correlId = cluster.createCorrel();
         mapCorrelToDeferred.put(correlId, lookup);
         if (resolve.path.steps().get(0).i < 0) {
           return Pair.of(rexBuilder.makeCorrel(rowType, correlId), null);
         } else {
           final RelDataTypeFactory.Builder builder = typeFactory.builder();
           final ListScope ancestorScope1 = (ListScope) resolve.scope;
           final ImmutableMap.Builder<String, Integer> fields = ImmutableMap.builder();
           int i = 0;
           int offset = 0;
           for (SqlValidatorNamespace c : ancestorScope1.getChildren()) {
             builder.addAll(c.getRowType().getFieldList());
             if (i == resolve.path.steps().get(0).i) {
               for (RelDataTypeField field : c.getRowType().getFieldList()) {
                 fields.put(field.getName(), field.getIndex() + offset);
               }
             }
             ++i;
             offset += c.getRowType().getFieldCount();
           }
           final RexNode c = rexBuilder.makeCorrel(builder.uniquify().build(), correlId);
           return Pair.of(c, fields.build());
         }
       }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ register() [1/2]

RexNode org.apache.calcite.sql2rel.SqlToRelConverter.Blackboard.register	(	RelNode	rel,
		JoinRelType	joinType
	)

inline

Definition at line 4182 of file SqlToRelConverter.java.

Referenced by org.apache.calcite.sql2rel.SqlToRelConverter.substituteSubQuery().

                                                                {
       return register(rel, joinType, null);
     }

Here is the caller graph for this function:

◆ register() [2/2]

RexNode org.apache.calcite.sql2rel.SqlToRelConverter.Blackboard.register	(	RelNode	rel,
		JoinRelType	joinType,
		List< RexNode >	leftKeys
	)

inline

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

Definition at line 4195 of file SqlToRelConverter.java.

References org.apache.calcite.sql2rel.SqlToRelConverter.createJoin(), join(), org.apache.calcite.sql2rel.SqlToRelConverter.relBuilder, org.apache.calcite.sql2rel.SqlToRelConverter.rexBuilder, and org.apache.calcite.sql2rel.SqlToRelConverter.typeFactory.

                                                                                        {
       assert joinType != null;
       if (root == null) {
         assert leftKeys == null;
         setRoot(rel, false);
         return rexBuilder.makeRangeReference(root.getRowType(), 0, false);
       }
 
       final RexNode joinCond;
       final int origLeftInputCount = root.getRowType().getFieldCount();
       if (leftKeys != null) {
         List<RexNode> newLeftInputExprs = new ArrayList<>();
         for (int i = 0; i < origLeftInputCount; i++) {
           newLeftInputExprs.add(rexBuilder.makeInputRef(root, i));
         }
 
         final List<Integer> leftJoinKeys = new ArrayList<>();
         for (RexNode leftKey : leftKeys) {
           int index = newLeftInputExprs.indexOf(leftKey);
           if (index < 0 || joinType == JoinRelType.LEFT) {
             index = newLeftInputExprs.size();
             newLeftInputExprs.add(leftKey);
           }
           leftJoinKeys.add(index);
         }
 
         RelNode newLeftInput = relBuilder.push(root).project(newLeftInputExprs).build();
 
         // maintain the group by mapping in the new LogicalProject
         if (mapRootRelToFieldProjection.containsKey(root)) {
           mapRootRelToFieldProjection.put(
                   newLeftInput, mapRootRelToFieldProjection.get(root));
         }
 
         setRoot(newLeftInput, false);
 
         // right fields appear after the LHS fields.
         final int rightOffset = root.getRowType().getFieldCount()
                 - newLeftInput.getRowType().getFieldCount();
         final List<Integer> rightKeys =
                 Util.range(rightOffset, rightOffset + leftKeys.size());
 
         joinCond = RelOptUtil.createEquiJoinCondition(
                 newLeftInput, leftJoinKeys, rel, rightKeys, rexBuilder);
       } else {
         joinCond = rexBuilder.makeLiteral(true);
       }
 
       int leftFieldCount = root.getRowType().getFieldCount();
       final RelNode join = createJoin(this, root, rel, joinCond, joinType);
 
       setRoot(join, false);
 
       if (leftKeys != null && joinType == JoinRelType.LEFT) {
         final int leftKeyCount = leftKeys.size();
         int rightFieldLength = rel.getRowType().getFieldCount();
         assert leftKeyCount == rightFieldLength - 1;
 
         final int rexRangeRefLength = leftKeyCount + rightFieldLength;
         RelDataType returnType = typeFactory.createStructType(
                 new AbstractList<Map.Entry<String, RelDataType>>() {
                   public Map.Entry<String, RelDataType> get(int index) {
                     return join.getRowType().getFieldList().get(
                             origLeftInputCount + index);
                   }
 
                   public int size() {
                     return rexRangeRefLength;
                   }
                 });
 
         return rexBuilder.makeRangeReference(returnType, origLeftInputCount, false);
       } else {
         return rexBuilder.makeRangeReference(
                 rel.getRowType(), leftFieldCount, joinType.generatesNullsOnRight());
       }
     }

Here is the call graph for this function:

◆ setDataset()

void org.apache.calcite.sql2rel.SqlToRelConverter.Blackboard.setDataset ( String datasetName )

inline

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

Definition at line 4311 of file SqlToRelConverter.java.

Referenced by org.apache.calcite.sql2rel.SqlToRelConverter.convertIdentifier().

4311 {}

Here is the caller graph for this function:

◆ setPatternVarRef()

void org.apache.calcite.sql2rel.SqlToRelConverter.Blackboard.setPatternVarRef ( boolean isVarRef )

inline

Definition at line 4178 of file SqlToRelConverter.java.

Referenced by org.apache.calcite.sql2rel.SqlToRelConverter.convertMatchRecognize().

                                                    {
       this.isPatternVarRef = isVarRef;
     }

Here is the caller graph for this function:

◆ setRoot() [1/3]

void org.apache.calcite.sql2rel.SqlToRelConverter.Blackboard.setRoot	(	RelNode	root,
		boolean	leaf
	)

inline

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.

Definition at line 4284 of file SqlToRelConverter.java.

References org.apache.calcite.sql2rel.SqlToRelConverter.leaves.

                                                     {
       setRoot(Collections.singletonList(root), root, root instanceof LogicalJoin);
       if (leaf) {
         leaves.put(root, root.getRowType().getFieldCount());
       }
       this.columnMonotonicities.clear();
     }

Here is the caller graph for this function:

◆ setRoot() [2/3]

void org.apache.calcite.sql2rel.SqlToRelConverter.Blackboard.setRoot	(	List< RelNode >	inputs,
		RelNode	root,
		boolean	hasSystemFields
	)

inlineprivate

Definition at line 4292 of file SqlToRelConverter.java.

References org.apache.calcite.sql2rel.SqlToRelConverter.getSystemFields().

                                                                                       {
       this.inputs = inputs;
       this.root = root;
       this.systemFieldList.clear();
       if (hasSystemFields) {
         this.systemFieldList.addAll(getSystemFields());
       }
     }

Here is the call graph for this function:

◆ setRoot() [3/3]

void org.apache.calcite.sql2rel.SqlToRelConverter.Blackboard.setRoot ( List< RelNode > inputs )

inlinepackage

Definition at line 4313 of file SqlToRelConverter.java.

                                        {
       setRoot(inputs, null, false);
     }

Member Data Documentation

◆ agg

AggConverter org.apache.calcite.sql2rel.SqlToRelConverter.Blackboard.agg

package

Workspace for building aggregates.

Definition at line 4125 of file SqlToRelConverter.java.

Referenced by org.apache.calcite.sql2rel.SqlToRelConverter.NoOpSubQueryConverter.convertSubQuery(), and org.apache.calcite.sql2rel.SqlToRelConverter.createAggImpl().

◆ columnMonotonicities

final List<SqlMonotonicity> org.apache.calcite.sql2rel.SqlToRelConverter.Blackboard.columnMonotonicities = new ArrayList<>()

private

Definition at line 4141 of file SqlToRelConverter.java.

Referenced by org.apache.calcite.sql2rel.SqlToRelConverter.convertSelectList(), and org.apache.calcite.sql2rel.SqlToRelConverter.createAggImpl().

◆ cursors

final List<RelNode> org.apache.calcite.sql2rel.SqlToRelConverter.Blackboard.cursors = new ArrayList<>()

package

Definition at line 4114 of file SqlToRelConverter.java.

Referenced by org.apache.calcite.sql2rel.SqlToRelConverter.convertCursor(), and org.apache.calcite.sql2rel.SqlToRelConverter.substituteSubQuery().

◆ initializerExpressionFactory

final InitializerExpressionFactory org.apache.calcite.sql2rel.SqlToRelConverter.Blackboard.initializerExpressionFactory

private

Initial value:

=

new NullInitializerExpressionFactory()

Definition at line 4146 of file SqlToRelConverter.java.

◆ inputs

List<RelNode> org.apache.calcite.sql2rel.SqlToRelConverter.Blackboard.inputs

private

Definition at line 4109 of file SqlToRelConverter.java.

◆ isPatternVarRef

boolean org.apache.calcite.sql2rel.SqlToRelConverter.Blackboard.isPatternVarRef = false

private

Definition at line 4112 of file SqlToRelConverter.java.

Referenced by org.apache.calcite.sql2rel.SqlToRelConverter.convertIdentifier().

◆ mapCorrelateToRex

final Map<CorrelationId, RexFieldAccess> org.apache.calcite.sql2rel.SqlToRelConverter.Blackboard.mapCorrelateToRex = new HashMap<>()

private

Definition at line 4110 of file SqlToRelConverter.java.

Referenced by org.apache.calcite.sql2rel.SqlToRelConverter.convertIdentifier(), and org.apache.calcite.sql2rel.SqlToRelConverter.DeferredLookup.getFieldAccess().

◆ mapRootRelToFieldProjection

final Map<RelNode, Map<Integer, Integer> > org.apache.calcite.sql2rel.SqlToRelConverter.Blackboard.mapRootRelToFieldProjection

private

Initial value:

=

new HashMap<>()

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.

Definition at line 4138 of file SqlToRelConverter.java.

Referenced by org.apache.calcite.sql2rel.SqlToRelConverter.createAggImpl(), and org.apache.calcite.sql2rel.SqlToRelConverter.getCorrelationUse().

◆ nameToNodeMap

final Map<String, RexNode> org.apache.calcite.sql2rel.SqlToRelConverter.Blackboard.nameToNodeMap

private

Definition at line 4107 of file SqlToRelConverter.java.

Referenced by org.apache.calcite.sql2rel.SqlToRelConverter.collectInsertTargets().

◆ root

RelNode org.apache.calcite.sql2rel.SqlToRelConverter.Blackboard.root

Definition at line 4108 of file SqlToRelConverter.java.

◆ scope

final SqlValidatorScope org.apache.calcite.sql2rel.SqlToRelConverter.Blackboard.scope

Collection of RelNode objects which correspond to a SELECT statement.

Definition at line 4106 of file SqlToRelConverter.java.

◆ subQueryList

final List<SubQuery> org.apache.calcite.sql2rel.SqlToRelConverter.Blackboard.subQueryList = new ArrayList<>()

private

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

Definition at line 4120 of file SqlToRelConverter.java.

Referenced by org.apache.calcite.sql2rel.SqlToRelConverter.replaceSubQueries().

◆ systemFieldList

final List<RelDataTypeField> org.apache.calcite.sql2rel.SqlToRelConverter.Blackboard.systemFieldList = new ArrayList<>()

private

Definition at line 4143 of file SqlToRelConverter.java.

◆ top

final boolean org.apache.calcite.sql2rel.SqlToRelConverter.Blackboard.top

package

Definition at line 4144 of file SqlToRelConverter.java.

Referenced by org.apache.calcite.sql2rel.SqlToRelConverter.convertOrder(), and org.apache.calcite.sql2rel.SqlToRelConverter.gatherOrderExprs().

◆ window

SqlWindow org.apache.calcite.sql2rel.SqlToRelConverter.Blackboard.window

package

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

Definition at line 4131 of file SqlToRelConverter.java.

Referenced by org.apache.calcite.sql2rel.SqlToRelConverter.convertOver().

The documentation for this class was generated from the following file:

/home/jenkins-slave/workspace/core-os-doxygen/java/calcite/src/main/java/org/apache/calcite/sql2rel/SqlToRelConverter.java

Public Member Functions

Public Attributes

Protected Member Functions

Package Functions

Package Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Blackboard()

Member Function Documentation

◆ getTopNode()

◆ lookupExp()

◆ register() [1/2]

◆ register() [2/2]

◆ setDataset()

◆ setPatternVarRef()

◆ setRoot() [1/3]

◆ setRoot() [2/3]

◆ setRoot() [3/3]

Member Data Documentation

◆ agg

◆ columnMonotonicities

◆ cursors

◆ initializerExpressionFactory

◆ inputs

◆ isPatternVarRef

◆ mapCorrelateToRex

◆ mapRootRelToFieldProjection

◆ nameToNodeMap

◆ root

◆ scope

◆ subQueryList

◆ systemFieldList

◆ top

◆ window