org.apache.calcite.rel.logical

Class LogicalJoin

java.lang.Object

org.apache.calcite.rel.AbstractRelNode

org.apache.calcite.rel.BiRel

org.apache.calcite.rel.core.Join

org.apache.calcite.rel.logical.LogicalJoin

All Implemented Interfaces:

Cloneable, RelOptNode, Hintable, RelNode

public final class LogicalJoin
extends Join

Sub-class of Join not targeted at any particular engine or calling convention.

Some rules:

• JoinExtractFilterRule converts an inner join to a filter on top of a cartesian inner join.
• net.sf.farrago.fennel.rel.FennelCartesianJoinRule implements a LogicalJoin as a cartesian product.

Nested Class Summary

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

RelNode.Context

Field Summary

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

condition, hints, joinInfo, joinType, variablesSet

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
LogicalJoin(RelInput input) Creates a LogicalJoin by parsing serialized output.
LogicalJoin(RelOptCluster cluster, RelNode left, RelNode right, RexNode condition, JoinRelType joinType, Set<String> variablesStopped) Deprecated.
LogicalJoin(RelOptCluster cluster, RelNode left, RelNode right, RexNode condition, JoinRelType joinType, Set<String> variablesStopped, boolean semiJoinDone, com.google.common.collect.ImmutableList<RelDataTypeField> systemFieldList) Deprecated.
LogicalJoin(RelOptCluster cluster, RelTraitSet traitSet, List<RelHint> hints, RelNode left, RelNode right, RexNode condition, Set<CorrelationId> variablesSet, JoinRelType joinType, boolean semiJoinDone, com.google.common.collect.ImmutableList<RelDataTypeField> systemFieldList) Creates a LogicalJoin.
LogicalJoin(RelOptCluster cluster, RelTraitSet traitSet, RelNode left, RelNode right, RexNode condition, JoinRelType joinType, Set<String> variablesStopped, boolean semiJoinDone, com.google.common.collect.ImmutableList<RelDataTypeField> systemFieldList) Deprecated.
LogicalJoin(RelOptCluster cluster, RelTraitSet traitSet, RelNode left, RelNode right, RexNode condition, Set<CorrelationId> variablesSet, JoinRelType joinType, boolean semiJoinDone, com.google.common.collect.ImmutableList<RelDataTypeField> systemFieldList) Deprecated.

Method Summary

Modifier and Type	Method and Description
RelNode	accept(RelShuttle shuttle) Accepts a visit from a shuttle.
LogicalJoin	copy(RelTraitSet traitSet, RexNode conditionExpr, RelNode left, RelNode right, JoinRelType joinType, boolean semiJoinDone) Creates a copy of this join, overriding condition, system fields and inputs.
static LogicalJoin	create(RelNode left, RelNode right, List<RelHint> hints, RexNode condition, Set<CorrelationId> variablesSet, JoinRelType joinType) Creates a LogicalJoin.
static LogicalJoin	create(RelNode left, RelNode right, List<RelHint> hints, RexNode condition, Set<CorrelationId> variablesSet, JoinRelType joinType, boolean semiJoinDone, com.google.common.collect.ImmutableList<RelDataTypeField> systemFieldList) Creates a LogicalJoin, flagged with whether it has been translated to a semi-join.
boolean	deepEquals(@Nullable Object obj) Equality check for RelNode digest.
int	deepHashCode() Compute hash code for RelNode digest.
RelWriter	explainTerms(RelWriter pw) Describes the inputs and attributes of this relational expression.
List<RelDataTypeField>	getSystemFieldList() Returns a list of system fields that will be prefixed to output row type.
boolean	isSemiJoinDone() Returns whether this LogicalJoin has already spawned a SemiJoin via JoinAddRedundantSemiJoinRule.
RelNode	withHints(List<RelHint> hintList) Returns a new relational expression with the specified hints hintList.

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

accept, analyzeCondition, computeSelfCost, copy, createJoinType, deepEquals0, deepHashCode0, deriveJoinRowType, deriveRowType, estimateJoinedRows, estimateRowCount, getCondition, getHints, getJoinType, getVariablesSet, isSemiJoin, isValid

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

childrenAccept, getInputs, getLeft, getRight, replaceInput

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

collectVariablesSet, collectVariablesUsed, equals, explain, getCluster, getConvention, getCorrelVariable, 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, fieldIsNullable

Constructor Detail

LogicalJoin

public LogicalJoin(RelOptCluster cluster,
                   RelTraitSet traitSet,
                   List<RelHint> hints,
                   RelNode left,
                   RelNode right,
                   RexNode condition,
                   Set<CorrelationId> variablesSet,
                   JoinRelType joinType,
                   boolean semiJoinDone,
                   com.google.common.collect.ImmutableList<RelDataTypeField> systemFieldList)

Creates a LogicalJoin.

Use create(org.apache.calcite.rel.RelNode, org.apache.calcite.rel.RelNode, java.util.List<org.apache.calcite.rel.hint.RelHint>, org.apache.calcite.rex.RexNode, java.util.Set<org.apache.calcite.rel.core.CorrelationId>, org.apache.calcite.rel.core.JoinRelType) unless you know what you're doing.

Parameters:

cluster - Cluster

traitSet - Trait set

hints - Hints

left - Left input

right - Right input

condition - Join condition

joinType - Join type

variablesSet - Set of variables that are set by the LHS and used by the RHS and are not available to nodes above this LogicalJoin in the tree

semiJoinDone - Whether this join has been translated to a semi-join

systemFieldList - List of system fields that will be prefixed to output row type; typically empty but must not be null

See Also:

isSemiJoinDone()

LogicalJoin

@Deprecated
public LogicalJoin(RelOptCluster cluster,
                               RelTraitSet traitSet,
                               RelNode left,
                               RelNode right,
                               RexNode condition,
                               Set<CorrelationId> variablesSet,
                               JoinRelType joinType,
                               boolean semiJoinDone,
                               com.google.common.collect.ImmutableList<RelDataTypeField> systemFieldList)

Deprecated.

LogicalJoin

@Deprecated
public LogicalJoin(RelOptCluster cluster,
                               RelTraitSet traitSet,
                               RelNode left,
                               RelNode right,
                               RexNode condition,
                               JoinRelType joinType,
                               Set<String> variablesStopped,
                               boolean semiJoinDone,
                               com.google.common.collect.ImmutableList<RelDataTypeField> systemFieldList)

Deprecated.

LogicalJoin

@Deprecated
public LogicalJoin(RelOptCluster cluster,
                               RelNode left,
                               RelNode right,
                               RexNode condition,
                               JoinRelType joinType,
                               Set<String> variablesStopped)

Deprecated.

LogicalJoin

@Deprecated
public LogicalJoin(RelOptCluster cluster,
                               RelNode left,
                               RelNode right,
                               RexNode condition,
                               JoinRelType joinType,
                               Set<String> variablesStopped,
                               boolean semiJoinDone,
                               com.google.common.collect.ImmutableList<RelDataTypeField> systemFieldList)

Deprecated.

LogicalJoin

public LogicalJoin(RelInput input)

Creates a LogicalJoin by parsing serialized output.

Method Detail

create

public static LogicalJoin create(RelNode left,
                                 RelNode right,
                                 List<RelHint> hints,
                                 RexNode condition,
                                 Set<CorrelationId> variablesSet,
                                 JoinRelType joinType)

Creates a LogicalJoin.

create

public static LogicalJoin create(RelNode left,
                                 RelNode right,
                                 List<RelHint> hints,
                                 RexNode condition,
                                 Set<CorrelationId> variablesSet,
                                 JoinRelType joinType,
                                 boolean semiJoinDone,
                                 com.google.common.collect.ImmutableList<RelDataTypeField> systemFieldList)

Creates a LogicalJoin, flagged with whether it has been translated to a semi-join.

copy

public LogicalJoin copy(RelTraitSet traitSet,
                        RexNode conditionExpr,
                        RelNode left,
                        RelNode right,
                        JoinRelType joinType,
                        boolean semiJoinDone)

Description copied from class: Join

Creates a copy of this join, overriding condition, system fields and inputs.

General contract as RelNode.copy(org.apache.calcite.plan.RelTraitSet, java.util.List<org.apache.calcite.rel.RelNode>).

Specified by:

copy in class Join

Parameters:

traitSet - Traits

conditionExpr - Condition

left - Left input

right - Right input

joinType - Join type

semiJoinDone - Whether this join has been translated to a semi-join

Returns:

Copy of this join

accept

public RelNode accept(RelShuttle shuttle)

Description copied from interface: RelNode

Accepts a visit from a shuttle.

Specified by:

accept in interface RelNode

Overrides:

accept in class AbstractRelNode

Parameters:

shuttle - Shuttle

Returns:

A copy of this node incorporating changes made by the shuttle to this node's children

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 Join

Parameters:

pw - Plan writer

Returns:

Plan writer for fluent-explain pattern

deepEquals

public boolean deepEquals(@Nullable Object obj)

Description copied from class: AbstractRelNode

Equality check for RelNode digest.

By default this method collects digest attributes from AbstractRelNode.explainTerms(RelWriter), then compares each attribute pair. This should work well for most cases. If this method is a performance bottleneck for your project, or the default behavior can't handle your scenario properly, you can choose to override this method and AbstractRelNode.deepHashCode(). See LogicalJoin as an example.

Specified by:

deepEquals in interface RelNode

Overrides:

deepEquals in class AbstractRelNode

Returns:

Whether the 2 RelNodes are equivalent or have the same digest.

See Also:

AbstractRelNode.deepHashCode()

deepHashCode

public int deepHashCode()

Description copied from class: AbstractRelNode

Compute hash code for RelNode digest.

Specified by:

deepHashCode in interface RelNode

Overrides:

deepHashCode in class AbstractRelNode

See Also:

RelNode.deepEquals(Object)

isSemiJoinDone

public boolean isSemiJoinDone()

Description copied from class: Join

Returns whether this LogicalJoin has already spawned a SemiJoin via JoinAddRedundantSemiJoinRule.

The base implementation returns false.

Overrides:

isSemiJoinDone in class Join

Returns:

whether this join has already spawned a semi join

getSystemFieldList

public List<RelDataTypeField> getSystemFieldList()

Description copied from class: Join

Returns a list of system fields that will be prefixed to output row type.

Overrides:

getSystemFieldList in class Join

Returns:

list of system fields

withHints

public RelNode withHints(List<RelHint> hintList)

Description copied from interface: Hintable

Returns a new relational expression with the specified hints hintList.

This method should be overridden by every logical node that supports hint. It is only for internal use during decorrelation.

Sub-class should return a new copy of the relational expression.

The default implementation returns the relational expression directly only because not every kind of relational expression supports hints.

Returns:

Relational expression with set up hints