Package org.apache.calcite.rel.core

Class Join

java.lang.Object

org.apache.calcite.rel.AbstractRelNode

org.apache.calcite.rel.BiRel

org.apache.calcite.rel.core.Join

All Implemented Interfaces:

Cloneable, RelOptNode, Hintable, RelNode

Direct Known Subclasses:

AsofJoin, Bindables.BindableJoin, EnumerableBatchNestedLoopJoin, EnumerableHashJoin, EnumerableMergeJoin, EnumerableNestedLoopJoin, EquiJoin, JdbcRules.JdbcJoin, LogicalJoin, PigJoin

public abstract class Join
extends BiRel
implements Hintable

Relational expression that combines two relational expressions according to some condition.

Each output row has columns from the left and right inputs. The set of output rows is a subset of the cartesian product of the two inputs; precisely which subset depends on the join condition.

Nested Class Summary

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

RelNode.Context

Field Summary

Fields

Modifier and Type	Field	Description
protected final RexNode	condition
protected final com.google.common.collect.ImmutableList<RelHint>	hints
protected final JoinInfo	joinInfo
protected final JoinRelType	joinType	Values must be of enumeration JoinRelType, except that JoinRelType.RIGHT is disallowed.
protected final com.google.common.collect.ImmutableSet<CorrelationId>	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

Modifier	Constructor	Description
protected	Join(RelOptCluster cluster, RelTraitSet traitSet, List<RelHint> hints, RelNode left, RelNode right, RexNode condition, Set<CorrelationId> variablesSet, JoinRelType joinType)	Creates a Join.
protected	Join(RelOptCluster cluster, RelTraitSet traitSet, RelNode left, RelNode right, RexNode condition, Set<CorrelationId> variablesSet, JoinRelType joinType)	Deprecated.
protected	Join(RelOptCluster cluster, RelTraitSet traitSet, RelNode left, RelNode right, RexNode condition, JoinRelType joinType, Set<String> variablesStopped)	Deprecated.

Method Summary

Modifier and Type	Method	Description
RelNode	accept(RexShuttle shuttle)	Accepts a visit from a shuttle.
JoinInfo	analyzeCondition()	Analyzes the join condition.
@Nullable RelOptCost	computeSelfCost(RelOptPlanner planner, RelMetadataQuery mq)	Returns the cost of this plan (not including children).
Join	copy(RelTraitSet traitSet, List<RelNode> inputs)	Creates a copy of this relational expression, perhaps changing traits and inputs.
abstract Join	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 RelDataType	createJoinType(RelDataTypeFactory typeFactory, RelDataType leftType, RelDataType rightType, List<String> fieldNameList, List<RelDataTypeField> systemFieldList)	Deprecated.
protected boolean	deepEquals0(@Nullable Object obj)
protected int	deepHashCode0()
static RelDataType	deriveJoinRowType(RelDataType leftType, RelDataType rightType, JoinRelType joinType, RelDataTypeFactory typeFactory, @Nullable List<String> fieldNameList, List<RelDataTypeField> systemFieldList)	Deprecated.
protected RelDataType	deriveRowType()
static double	estimateJoinedRows(Join joinRel, RexNode condition)	Deprecated. Use RelMdUtil.getJoinRowCount(RelMetadataQuery, Join, RexNode).
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.
RexNode	getCondition()
com.google.common.collect.ImmutableList<RelHint>	getHints()	Returns the hints of this relational expressions as an immutable list.
JoinRelType	getJoinType()
List<RelDataTypeField>	getSystemFieldList()	Returns a list of system fields that will be prefixed to output row type.
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	isSemiJoin()	Returns whether this Join is a semijoin.
boolean	isSemiJoinDone()	Returns whether this LogicalJoin has already spawned a SemiJoin via JoinAddRedundantSemiJoinRule.
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, collectVariablesSet, collectVariablesUsed, deepEquals, deepHashCode, 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, withHints

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

explain, fieldIsNullable, stripped

Field Details

condition

protected final RexNode condition

variablesSet

protected final com.google.common.collect.ImmutableSet<CorrelationId> variablesSet

hints

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

joinType

protected final JoinRelType joinType

Values must be of enumeration JoinRelType, except that JoinRelType.RIGHT is disallowed.

joinInfo

protected final JoinInfo joinInfo

Constructor Details

Join

protected Join(RelOptCluster cluster,
 RelTraitSet traitSet,
 List<RelHint> hints,
 RelNode left,
 RelNode right,
 RexNode condition,
 Set<CorrelationId> variablesSet,
 JoinRelType joinType)

Creates a Join.

Parameters:

cluster - Cluster

traitSet - Trait set

hints - Hints

left - Left input

right - Right input

condition - Join condition

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

joinType - Join type

Join

@Deprecated
protected Join(RelOptCluster cluster,
 RelTraitSet traitSet,
 RelNode left,
 RelNode right,
 RexNode condition,
 Set<CorrelationId> variablesSet,
 JoinRelType joinType)

Deprecated.

Join

@Deprecated
protected Join(RelOptCluster cluster,
 RelTraitSet traitSet,
 RelNode left,
 RelNode right,
 RexNode condition,
 JoinRelType joinType,
 Set<String> variablesStopped)

Deprecated.

Method Details

accept

public RelNode accept(RexShuttle shuttle)

Description copied from interface: RelNode

Accepts a visit from a shuttle. If the shuttle updates expression, then a copy of the relation should be created. This new relation might have a different row-type.

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

getCondition

public RexNode getCondition()

getJoinType

public JoinRelType getJoinType()

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

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)

estimateJoinedRows

@Deprecated
public static double estimateJoinedRows(Join joinRel,
 RexNode condition)

Deprecated.

Use RelMdUtil.getJoinRowCount(RelMetadataQuery, Join, RexNode).

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

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.

Specified by:

getVariablesSet in interface RelNode

Overrides:

getVariablesSet in class AbstractRelNode

Returns:

Names of variables which are set in this relational expression

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

deepEquals0

@API(since="1.24",
     status=INTERNAL)
@EnsuresNonNullIf(expression="#1",
                  result=true)
protected boolean deepEquals0(@Nullable Object obj)

deepHashCode0

@API(since="1.24",
     status=INTERNAL)
protected int deepHashCode0()

deriveRowType

protected RelDataType deriveRowType()

Overrides:

deriveRowType in class AbstractRelNode

isSemiJoinDone

public boolean isSemiJoinDone()

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

The base implementation returns false.

Returns:

whether this join has already spawned a semi join

isSemiJoin

public boolean isSemiJoin()

Returns whether this Join is a semijoin.

Returns:

true if this Join's join type is semi.

getSystemFieldList

public List<RelDataTypeField> getSystemFieldList()

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

Returns:

list of system fields

deriveJoinRowType

@Deprecated
public static RelDataType deriveJoinRowType(RelDataType leftType,
 RelDataType rightType,
 JoinRelType joinType,
 RelDataTypeFactory typeFactory,
 @Nullable List<String> fieldNameList,
 List<RelDataTypeField> systemFieldList)

Deprecated.

createJoinType

@Deprecated
public static RelDataType createJoinType(RelDataTypeFactory typeFactory,
 RelDataType leftType,
 RelDataType rightType,
 List<String> fieldNameList,
 List<RelDataTypeField> systemFieldList)

Deprecated.

copy

public Join 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 Join 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.

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

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

analyzeCondition

public JoinInfo analyzeCondition()

Analyzes the join condition.

Returns:

Analyzed join condition

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