org.apache.calcite.rel.core

Class Correlate

java.lang.Object

org.apache.calcite.rel.AbstractRelNode

org.apache.calcite.rel.BiRel

org.apache.calcite.rel.core.Correlate

All Implemented Interfaces:

Cloneable, RelOptNode, Hintable, RelNode

Direct Known Subclasses:

EnumerableCorrelate, LogicalCorrelate

public abstract class Correlate
extends BiRel
implements Hintable

A relational operator that performs nested-loop joins.

It behaves like a kind of Join, but works by setting variables in its environment and restarting its right-hand input.

Correlate is not a join since: typical rules should not match Correlate.

A Correlate is used to represent a correlated query. One implementation strategy is to de-correlate the expression.

Mapping of physical operations to logical ones

Physical operation	Logical operation
NestedLoops	Correlate(A, B, regular)
NestedLoopsOuter	Correlate(A, B, outer)
NestedLoopsSemi	Correlate(A, B, semi)
NestedLoopsAnti	Correlate(A, B, anti)
HashJoin	EquiJoin(A, B)
HashJoinOuter	EquiJoin(A, B, outer)
HashJoinSemi	SemiJoin(A, B, semi)
HashJoinAnti	SemiJoin(A, B, anti)

See Also:

CorrelationId

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.calcite.rel.RelNode

RelNode.Context

Field Summary

Fields

Modifier and Type	Field and Description
protected CorrelationId	correlationId
protected com.google.common.collect.ImmutableList<RelHint>	hints
protected JoinRelType	joinType
protected ImmutableBitSet	requiredColumns

Fields inherited from class org.apache.calcite.rel.BiRel

left, right

Fields inherited from class org.apache.calcite.rel.AbstractRelNode

digest, id, rowType, traitSet

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Correlate(RelInput input) Creates a Correlate by parsing serialized output.
protected	Correlate(RelOptCluster cluster, RelTraitSet traitSet, List<RelHint> hints, RelNode left, RelNode right, CorrelationId correlationId, ImmutableBitSet requiredColumns, JoinRelType joinType) Creates a Correlate.
protected	Correlate(RelOptCluster cluster, RelTraitSet traitSet, RelNode left, RelNode right, CorrelationId correlationId, ImmutableBitSet requiredColumns, JoinRelType joinType) Deprecated.

Method Summary

Modifier and Type	Method and Description
@Nullable RelOptCost	computeSelfCost(RelOptPlanner planner, RelMetadataQuery mq) Returns the cost of this plan (not including children).
Correlate	copy(RelTraitSet traitSet, List<RelNode> inputs) Creates a copy of this relational expression, perhaps changing traits and inputs.
abstract Correlate	copy(RelTraitSet traitSet, RelNode left, RelNode right, CorrelationId correlationId, ImmutableBitSet requiredColumns, JoinRelType joinType)
protected RelDataType	deriveRowType()
double	estimateRowCount(RelMetadataQuery mq) Returns an estimate of the number of rows this relational expression will return.
RelWriter	explainTerms(RelWriter pw) Describes the inputs and attributes of this relational expression.
CorrelationId	getCorrelationId() Returns the correlating expressions.
String	getCorrelVariable() Returns the name of the variable which is to be implicitly set at runtime each time a row is returned from the first input of this relational expression; or null if there is no variable.
com.google.common.collect.ImmutableList<RelHint>	getHints() Returns the hints of this relational expressions as an immutable list.
JoinRelType	getJoinType()
ImmutableBitSet	getRequiredColumns() Returns the required columns in left relation required for the correlation in the right.
Set<CorrelationId>	getVariablesSet() Returns the variables that are set in this relational expression but also used and therefore not available to parents of this relational expression.
boolean	isValid(Litmus litmus, @Nullable RelNode.Context context) Returns whether this relational expression is valid.

Methods inherited from class org.apache.calcite.rel.BiRel

childrenAccept, getInputs, getLeft, getRight, replaceInput

Methods inherited from class org.apache.calcite.rel.AbstractRelNode

accept, accept, collectVariablesSet, collectVariablesUsed, deepEquals, deepHashCode, equals, explain, getCluster, getConvention, getDescription, getDigest, getExpectedInputRowType, getId, getInput, getRelDigest, getRelTypeName, getRowType, getTable, getTraitSet, hashCode, isEnforcer, metadata, onRegister, recomputeDigest, register, sole, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.calcite.rel.hint.Hintable

attachHints, withHints

Methods inherited from interface org.apache.calcite.rel.RelNode

explain, fieldIsNullable

Field Detail

correlationId

protected final CorrelationId correlationId

requiredColumns

protected final ImmutableBitSet requiredColumns

joinType

protected final JoinRelType joinType

hints

protected final com.google.common.collect.ImmutableList<RelHint> hints

Constructor Detail

Correlate

protected Correlate(RelOptCluster cluster,
                    RelTraitSet traitSet,
                    List<RelHint> hints,
                    RelNode left,
                    RelNode right,
                    CorrelationId correlationId,
                    ImmutableBitSet requiredColumns,
                    JoinRelType joinType)

Creates a Correlate.

Parameters:

cluster - Cluster this relational expression belongs to

left - Left input relational expression

right - Right input relational expression

correlationId - Variable name for the row of left input

requiredColumns - Set of columns that are used by correlation

joinType - Join type

Correlate

@Deprecated
protected Correlate(RelOptCluster cluster,
                                RelTraitSet traitSet,
                                RelNode left,
                                RelNode right,
                                CorrelationId correlationId,
                                ImmutableBitSet requiredColumns,
                                JoinRelType joinType)

Deprecated.

Correlate

protected Correlate(RelInput input)

Creates a Correlate by parsing serialized output.

Parameters:

input - Input representation

Method Detail

isValid

public boolean isValid(Litmus litmus,
                       @Nullable RelNode.Context context)

Description copied from interface: RelNode

Returns whether this relational expression is valid.

If assertions are enabled, this method is typically called with litmus = THROW, as follows:

assert rel.isValid(Litmus.THROW)

This signals that the method can throw an AssertionError if it is not valid.

Specified by:

isValid in interface RelNode

Overrides:

isValid in class AbstractRelNode

Parameters:

litmus - What to do if invalid

context - Context for validity checking

Returns:

Whether relational expression is valid

copy

public Correlate copy(RelTraitSet traitSet,
                      List<RelNode> inputs)

Description copied from interface: RelNode

Creates a copy of this relational expression, perhaps changing traits and inputs.

Sub-classes with other important attributes are encouraged to create variants of this method with more parameters.

Specified by:

copy in interface RelNode

Overrides:

copy in class AbstractRelNode

Parameters:

traitSet - Trait set

inputs - Inputs

Returns:

Copy of this relational expression, substituting traits and inputs

copy

public abstract Correlate copy(RelTraitSet traitSet,
                               RelNode left,
                               RelNode right,
                               CorrelationId correlationId,
                               ImmutableBitSet requiredColumns,
                               JoinRelType joinType)

getJoinType

public JoinRelType getJoinType()

deriveRowType

protected RelDataType deriveRowType()

Overrides:

deriveRowType in class AbstractRelNode

explainTerms

public RelWriter explainTerms(RelWriter pw)

Description copied from class: AbstractRelNode

Describes the inputs and attributes of this relational expression. Each node should call super.explainTerms, then call the RelWriter.input(String, RelNode) and RelWriter.item(String, Object) methods for each input and attribute.

Overrides:

explainTerms in class BiRel

Parameters:

pw - Plan writer

Returns:

Plan writer for fluent-explain pattern

getCorrelationId

public CorrelationId getCorrelationId()

Returns the correlating expressions.

Returns:

correlating expressions

getCorrelVariable

public String getCorrelVariable()

Description copied from interface: RelNode

Returns the name of the variable which is to be implicitly set at runtime each time a row is returned from the first input of this relational expression; or null if there is no variable.

Specified by:

getCorrelVariable in interface RelNode

Overrides:

getCorrelVariable in class AbstractRelNode

Returns:

Name of correlating variable, or null

getRequiredColumns

public ImmutableBitSet getRequiredColumns()

Returns the required columns in left relation required for the correlation in the right.

Returns:

columns in left relation required for the correlation in the right

getVariablesSet

public Set<CorrelationId> getVariablesSet()

Description copied from interface: RelNode

Returns the variables that are set in this relational expression but also used and therefore not available to parents of this relational expression.

Note: only Correlate should set variables.

Specified by:

getVariablesSet in interface RelNode

Overrides:

getVariablesSet in class AbstractRelNode

Returns:

Names of variables which are set in this relational expression

estimateRowCount

public double estimateRowCount(RelMetadataQuery mq)

Description copied from interface: RelNode

Returns an estimate of the number of rows this relational expression will return.

NOTE jvs 29-Mar-2006: Don't call this method directly. Instead, use RelMetadataQuery.getRowCount(org.apache.calcite.rel.RelNode), which gives plugins a chance to override the rel's default ideas about row count.

Specified by:

estimateRowCount in interface RelNode

Overrides:

estimateRowCount in class AbstractRelNode

Parameters:

mq - Metadata query

Returns:

Estimate of the number of rows this relational expression will return

computeSelfCost

public @Nullable RelOptCost computeSelfCost(RelOptPlanner planner,
                                            RelMetadataQuery mq)

Description copied from interface: RelNode

Returns the cost of this plan (not including children). The base implementation throws an error; derived classes should override.

NOTE jvs 29-Mar-2006: Don't call this method directly. Instead, use RelMetadataQuery.getNonCumulativeCost(org.apache.calcite.rel.RelNode), which gives plugins a chance to override the rel's default ideas about cost.

Specified by:

computeSelfCost in interface RelNode

Overrides:

computeSelfCost in class AbstractRelNode

Parameters:

planner - Planner for cost calculation

mq - Metadata query

Returns:

Cost of this plan (not including children)

getHints

public com.google.common.collect.ImmutableList<RelHint> getHints()

Description copied from interface: Hintable

Returns the hints of this relational expressions as an immutable list.

Specified by:

getHints in interface Hintable