org.apache.calcite.rel.logical

Class LogicalCorrelate

java.lang.Object

org.apache.calcite.rel.AbstractRelNode

org.apache.calcite.rel.BiRel

org.apache.calcite.rel.core.Correlate

org.apache.calcite.rel.logical.LogicalCorrelate

All Implemented Interfaces:

Cloneable, org.apache.calcite.plan.RelOptNode, org.apache.calcite.rel.hint.Hintable, org.apache.calcite.rel.RelNode

public final class LogicalCorrelate
extends Correlate

A relational operator that performs nested-loop joins.

Temporarily copy from calcite to cherry-pick [CALCITE-5107] and will be removed when upgrade the latest calcite.

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

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

See Also:

CorrelationId

Nested Class Summary

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

org.apache.calcite.rel.RelNode.Context

Field Summary

Fields inherited from class org.apache.calcite.rel.core.Correlate

correlationId, hints, joinType, 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

Constructor and Description
LogicalCorrelate(org.apache.calcite.rel.RelInput input) Creates a LogicalCorrelate by parsing serialized output.
LogicalCorrelate(org.apache.calcite.plan.RelOptCluster cluster, org.apache.calcite.plan.RelTraitSet traitSet, List<org.apache.calcite.rel.hint.RelHint> hints, org.apache.calcite.rel.RelNode left, org.apache.calcite.rel.RelNode right, org.apache.calcite.rel.core.CorrelationId correlationId, org.apache.calcite.util.ImmutableBitSet requiredColumns, org.apache.calcite.rel.core.JoinRelType joinType) Creates a LogicalCorrelate.
LogicalCorrelate(org.apache.calcite.plan.RelOptCluster cluster, org.apache.calcite.plan.RelTraitSet traitSet, org.apache.calcite.rel.RelNode left, org.apache.calcite.rel.RelNode right, org.apache.calcite.rel.core.CorrelationId correlationId, org.apache.calcite.util.ImmutableBitSet requiredColumns, org.apache.calcite.rel.core.JoinRelType joinType) Creates a LogicalCorrelate.

Method Summary

Modifier and Type	Method and Description
org.apache.calcite.rel.RelNode	accept(org.apache.calcite.rel.RelShuttle shuttle)
LogicalCorrelate	copy(org.apache.calcite.plan.RelTraitSet traitSet, org.apache.calcite.rel.RelNode left, org.apache.calcite.rel.RelNode right, org.apache.calcite.rel.core.CorrelationId correlationId, org.apache.calcite.util.ImmutableBitSet requiredColumns, org.apache.calcite.rel.core.JoinRelType joinType)
static LogicalCorrelate	create(org.apache.calcite.rel.RelNode left, org.apache.calcite.rel.RelNode right, org.apache.calcite.rel.core.CorrelationId correlationId, org.apache.calcite.util.ImmutableBitSet requiredColumns, org.apache.calcite.rel.core.JoinRelType joinType) Creates a LogicalCorrelate.
static LogicalCorrelate	create(org.apache.calcite.rel.RelNode left, org.apache.calcite.rel.RelNode right, List<org.apache.calcite.rel.hint.RelHint> hints, org.apache.calcite.rel.core.CorrelationId correlationId, org.apache.calcite.util.ImmutableBitSet requiredColumns, org.apache.calcite.rel.core.JoinRelType joinType) Creates a LogicalCorrelate.
org.apache.calcite.rel.RelNode	withHints(List<org.apache.calcite.rel.hint.RelHint> hintList)

Methods inherited from class org.apache.calcite.rel.core.Correlate

computeSelfCost, copy, deriveRowType, estimateRowCount, explainTerms, getCorrelationId, getCorrelVariable, getHints, getJoinType, getRequiredColumns, getVariablesSet, isValid

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

childrenAccept, getInputs, getLeft, getRight, replaceInput

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

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

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

explain

Constructor Detail

LogicalCorrelate

public LogicalCorrelate(org.apache.calcite.plan.RelOptCluster cluster,
                        org.apache.calcite.plan.RelTraitSet traitSet,
                        List<org.apache.calcite.rel.hint.RelHint> hints,
                        org.apache.calcite.rel.RelNode left,
                        org.apache.calcite.rel.RelNode right,
                        org.apache.calcite.rel.core.CorrelationId correlationId,
                        org.apache.calcite.util.ImmutableBitSet requiredColumns,
                        org.apache.calcite.rel.core.JoinRelType joinType)

Creates a LogicalCorrelate.

Parameters:

cluster - cluster this relational expression belongs to

hints - hints for this node

left - left input relational expression

right - right input relational expression

correlationId - variable name for the row of left input

requiredColumns - Required columns

joinType - join type

LogicalCorrelate

public LogicalCorrelate(org.apache.calcite.plan.RelOptCluster cluster,
                        org.apache.calcite.plan.RelTraitSet traitSet,
                        org.apache.calcite.rel.RelNode left,
                        org.apache.calcite.rel.RelNode right,
                        org.apache.calcite.rel.core.CorrelationId correlationId,
                        org.apache.calcite.util.ImmutableBitSet requiredColumns,
                        org.apache.calcite.rel.core.JoinRelType joinType)

Creates a LogicalCorrelate.

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 - Required columns

joinType - join type

LogicalCorrelate

public LogicalCorrelate(org.apache.calcite.rel.RelInput input)

Creates a LogicalCorrelate by parsing serialized output.

Method Detail

create

public static LogicalCorrelate create(org.apache.calcite.rel.RelNode left,
                                      org.apache.calcite.rel.RelNode right,
                                      List<org.apache.calcite.rel.hint.RelHint> hints,
                                      org.apache.calcite.rel.core.CorrelationId correlationId,
                                      org.apache.calcite.util.ImmutableBitSet requiredColumns,
                                      org.apache.calcite.rel.core.JoinRelType joinType)

Creates a LogicalCorrelate.

create

public static LogicalCorrelate create(org.apache.calcite.rel.RelNode left,
                                      org.apache.calcite.rel.RelNode right,
                                      org.apache.calcite.rel.core.CorrelationId correlationId,
                                      org.apache.calcite.util.ImmutableBitSet requiredColumns,
                                      org.apache.calcite.rel.core.JoinRelType joinType)

Creates a LogicalCorrelate.

copy

public LogicalCorrelate copy(org.apache.calcite.plan.RelTraitSet traitSet,
                             org.apache.calcite.rel.RelNode left,
                             org.apache.calcite.rel.RelNode right,
                             org.apache.calcite.rel.core.CorrelationId correlationId,
                             org.apache.calcite.util.ImmutableBitSet requiredColumns,
                             org.apache.calcite.rel.core.JoinRelType joinType)

Specified by:

copy in class Correlate

accept

public org.apache.calcite.rel.RelNode accept(org.apache.calcite.rel.RelShuttle shuttle)

Specified by:

accept in interface org.apache.calcite.rel.RelNode

Overrides:

accept in class org.apache.calcite.rel.AbstractRelNode

withHints

public org.apache.calcite.rel.RelNode withHints(List<org.apache.calcite.rel.hint.RelHint> hintList)