org.apache.calcite.sql2rel

Class RelDecorrelator

java.lang.Object

org.apache.calcite.sql2rel.RelDecorrelator

All Implemented Interfaces:

ReflectiveVisitor

public class RelDecorrelator
extends Object
implements ReflectiveVisitor

RelDecorrelator replaces all correlated expressions (corExp) in a relational expression (RelNode) tree with non-correlated expressions that are produced from joining the RelNode that produces the corExp with the RelNode that references it.

TODO:

• replace CorelMap constructor parameter with a RelNode
• make currentRel immutable (would require a fresh RelDecorrelator for each node being decorrelated)
• make fields of CorelMap immutable
• make sub-class rules static, and have them create their own de-correlator

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RelDecorrelator.AdjustProjectForCountAggregateRule Planner rule that adjusts projects when counts are added.
static interface	RelDecorrelator.Config Base configuration for rules that are non-static in a RelDecorrelator.
protected static class	RelDecorrelator.CorelMap A map of the locations of Correlate in a tree of RelNodes.
static class	RelDecorrelator.CorelMapBuilder Builds a RelDecorrelator.CorelMap.
static class	RelDecorrelator.RemoveCorrelationForScalarAggregateRule Planner rule that removes correlations for scalar aggregates.
static class	RelDecorrelator.RemoveCorrelationForScalarProjectRule Planner rule that removes correlations for scalar projects.
static class	RelDecorrelator.RemoveSingleAggregateRule Rule to remove single_value rel.

Field Summary

Fields

Modifier and Type	Field and Description
protected RelDecorrelator.CorelMap	cm

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RelDecorrelator(RelDecorrelator.CorelMap cm, Context context, RelBuilder relBuilder)

Method Summary

Modifier and Type	Method and Description
protected RelNode	decorrelate(RelNode root)
protected RexNode	decorrelateExpr(RelNode currentRel, Map<RelNode,org.apache.calcite.sql2rel.RelDecorrelator.Frame> map, RelDecorrelator.CorelMap cm, RexNode exp)
static RelNode	decorrelateQuery(RelNode rootRel) Deprecated.
static RelNode	decorrelateQuery(RelNode rootRel, RelBuilder relBuilder) Decorrelates a query.
org.apache.calcite.sql2rel.RelDecorrelator.Frame	decorrelateRel(Aggregate rel)
org.apache.calcite.sql2rel.RelDecorrelator.Frame	decorrelateRel(Correlate rel)
org.apache.calcite.sql2rel.RelDecorrelator.Frame	decorrelateRel(Filter rel)
org.apache.calcite.sql2rel.RelDecorrelator.Frame	decorrelateRel(Join rel)
org.apache.calcite.sql2rel.RelDecorrelator.Frame	decorrelateRel(LogicalAggregate rel)
org.apache.calcite.sql2rel.RelDecorrelator.Frame	decorrelateRel(LogicalCorrelate rel)
org.apache.calcite.sql2rel.RelDecorrelator.Frame	decorrelateRel(LogicalFilter rel)
org.apache.calcite.sql2rel.RelDecorrelator.Frame	decorrelateRel(LogicalJoin rel)
org.apache.calcite.sql2rel.RelDecorrelator.Frame	decorrelateRel(LogicalProject rel)
org.apache.calcite.sql2rel.RelDecorrelator.Frame	decorrelateRel(LogicalSnapshot rel)
org.apache.calcite.sql2rel.RelDecorrelator.Frame	decorrelateRel(LogicalTableFunctionScan rel)
org.apache.calcite.sql2rel.RelDecorrelator.Frame	decorrelateRel(Project rel)
org.apache.calcite.sql2rel.RelDecorrelator.Frame	decorrelateRel(RelNode rel) Fallback if none of the other decorrelateRel methods match.
org.apache.calcite.sql2rel.RelDecorrelator.Frame	decorrelateRel(Sort rel)
org.apache.calcite.sql2rel.RelDecorrelator.Frame	decorrelateRel(Values rel)
org.apache.calcite.sql2rel.RelDecorrelator.Frame	getInvoke(RelNode r, RelNode parent)
protected RelBuilderFactory	relBuilderFactory()
protected RexNode	removeCorrelationExpr(RexNode exp, boolean projectPulledAboveLeftCorrelator)
protected RexNode	removeCorrelationExpr(RexNode exp, boolean projectPulledAboveLeftCorrelator, RexInputRef nullIndicator)
protected RexNode	removeCorrelationExpr(RexNode exp, boolean projectPulledAboveLeftCorrelator, Set<Integer> isCount)
RelNode	removeCorrelationViaRule(RelNode root)

Methods inherited from class java.lang.Object

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

Field Detail

cm

protected RelDecorrelator.CorelMap cm

Constructor Detail

RelDecorrelator

protected RelDecorrelator(RelDecorrelator.CorelMap cm,
                          Context context,
                          RelBuilder relBuilder)

Method Detail

decorrelateQuery

@Deprecated
public static RelNode decorrelateQuery(RelNode rootRel)

Deprecated.

decorrelateQuery

public static RelNode decorrelateQuery(RelNode rootRel,
                                       RelBuilder relBuilder)

Decorrelates a query.

This is the main entry point to RelDecorrelator.

Parameters:

rootRel - Root node of the query

relBuilder - Builder for relational expressions

Returns:

Equivalent query with all Correlate instances removed

relBuilderFactory

protected RelBuilderFactory relBuilderFactory()

decorrelate

protected RelNode decorrelate(RelNode root)

removeCorrelationViaRule

public RelNode removeCorrelationViaRule(RelNode root)

decorrelateExpr

protected RexNode decorrelateExpr(RelNode currentRel,
                                  Map<RelNode,org.apache.calcite.sql2rel.RelDecorrelator.Frame> map,
                                  RelDecorrelator.CorelMap cm,
                                  RexNode exp)

removeCorrelationExpr

protected RexNode removeCorrelationExpr(RexNode exp,
                                        boolean projectPulledAboveLeftCorrelator)

removeCorrelationExpr

protected RexNode removeCorrelationExpr(RexNode exp,
                                        boolean projectPulledAboveLeftCorrelator,
                                        RexInputRef nullIndicator)

removeCorrelationExpr

protected RexNode removeCorrelationExpr(RexNode exp,
                                        boolean projectPulledAboveLeftCorrelator,
                                        Set<Integer> isCount)

decorrelateRel

public org.apache.calcite.sql2rel.RelDecorrelator.Frame decorrelateRel(RelNode rel)

Fallback if none of the other decorrelateRel methods match.

decorrelateRel

public org.apache.calcite.sql2rel.RelDecorrelator.Frame decorrelateRel(Sort rel)

decorrelateRel

public org.apache.calcite.sql2rel.RelDecorrelator.Frame decorrelateRel(Values rel)

decorrelateRel

public org.apache.calcite.sql2rel.RelDecorrelator.Frame decorrelateRel(LogicalAggregate rel)

decorrelateRel

public org.apache.calcite.sql2rel.RelDecorrelator.Frame decorrelateRel(Aggregate rel)

getInvoke

public org.apache.calcite.sql2rel.RelDecorrelator.Frame getInvoke(RelNode r,
                                                                  RelNode parent)

decorrelateRel

public org.apache.calcite.sql2rel.RelDecorrelator.Frame decorrelateRel(LogicalProject rel)

decorrelateRel

public org.apache.calcite.sql2rel.RelDecorrelator.Frame decorrelateRel(Project rel)

decorrelateRel

public org.apache.calcite.sql2rel.RelDecorrelator.Frame decorrelateRel(LogicalSnapshot rel)

decorrelateRel

public org.apache.calcite.sql2rel.RelDecorrelator.Frame decorrelateRel(LogicalTableFunctionScan rel)

decorrelateRel

public org.apache.calcite.sql2rel.RelDecorrelator.Frame decorrelateRel(LogicalFilter rel)

decorrelateRel

public org.apache.calcite.sql2rel.RelDecorrelator.Frame decorrelateRel(Filter rel)

decorrelateRel

public org.apache.calcite.sql2rel.RelDecorrelator.Frame decorrelateRel(LogicalCorrelate rel)

decorrelateRel

public org.apache.calcite.sql2rel.RelDecorrelator.Frame decorrelateRel(Correlate rel)

decorrelateRel

public org.apache.calcite.sql2rel.RelDecorrelator.Frame decorrelateRel(LogicalJoin rel)

decorrelateRel

public org.apache.calcite.sql2rel.RelDecorrelator.Frame decorrelateRel(Join rel)