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, 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.

Field Summary

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

condition, joinType, variablesStopped

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, RelNode left, RelNode right, RexNode condition, JoinRelType joinType, Set<String> variablesStopped, boolean semiJoinDone, com.google.common.collect.ImmutableList<RelDataTypeField> systemFieldList) Creates a LogicalJoin.

Method Summary

Methods

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, RexNode condition, JoinRelType joinType, Set<String> variablesStopped) Creates a LogicalJoin.
static LogicalJoin	create(RelNode left, RelNode right, RexNode condition, JoinRelType joinType, Set<String> variablesStopped, boolean semiJoinDone, com.google.common.collect.ImmutableList<RelDataTypeField> systemFieldList) Creates a LogicalJoin, flagged with whether it has been translated to a semi-join.
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.

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

accept, analyzeCondition, computeSelfCost, copy, createJoinType, deriveJoinRowType, deriveRowType, estimateJoinedRows, getChildExps, getCondition, getJoinType, getRows, getVariablesStopped, 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, computeDigest, explain, getCluster, getCollationList, getConvention, getCorrelVariable, getDescription, getDigest, getExpectedInputRowType, getId, getInput, getQuery, getRelTypeName, getRowType, getTable, getTraitSet, isDistinct, isKey, isValid, metadata, onRegister, recomputeDigest, register, sole, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

LogicalJoin

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)

Creates a LogicalJoin.

Use create(org.apache.calcite.rel.RelNode, org.apache.calcite.rel.RelNode, org.apache.calcite.rex.RexNode, org.apache.calcite.rel.core.JoinRelType, java.util.Set<java.lang.String>, boolean, com.google.common.collect.ImmutableList<org.apache.calcite.rel.type.RelDataTypeField>) unless you know what you're doing.

Parameters:

cluster - Cluster

traitSet - Trait set

left - Left input

right - Right input

condition - Join condition

joinType - Join type

variablesStopped - Set of names of variables which 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,
                      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,
                 RexNode condition,
                 JoinRelType joinType,
                 Set<String> variablesStopped,
                 boolean semiJoinDone,
                 com.google.common.collect.ImmutableList<RelDataTypeField> systemFieldList)

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

create

public static LogicalJoin create(RelNode left,
                 RelNode right,
                 RexNode condition,
                 JoinRelType joinType,
                 Set<String> variablesStopped)

Creates a LogicalJoin.

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 RelWriterImpl.input(String, RelNode) and RelWriterImpl.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

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