Package org.apache.calcite.rel.logical

Class LogicalAsofJoin

java.lang.Object

org.apache.calcite.rel.AbstractRelNode

org.apache.calcite.rel.BiRel

org.apache.calcite.rel.core.Join

org.apache.calcite.rel.core.AsofJoin

org.apache.calcite.rel.logical.LogicalAsofJoin

All Implemented Interfaces:

Cloneable, RelOptNode, Hintable, RelNode

public final class LogicalAsofJoin
extends AsofJoin

Sub-class of AsofJoin encoding ASOF joins. Adapted from the LogicalJoin implementation.

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

matchCondition

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	Description
LogicalAsofJoin(RelOptCluster cluster, RelTraitSet traitSet, List<RelHint> hints, RelNode left, RelNode right, RexNode condition, RexNode matchCondition, JoinRelType joinType, com.google.common.collect.ImmutableList<RelDataTypeField> systemFieldList)	Creates a LogicalAsofJoin.
LogicalAsofJoin(RelInput input)	Creates a LogicalAsofJoin by parsing serialized output.

Method Summary

Modifier and Type	Method	Description
RelNode	accept(RelShuttle shuttle)	Accepts a visit from a shuttle.
Join	copy(RelTraitSet traitSet, List<RelNode> inputs)	Creates a copy of this relational expression, perhaps changing traits and inputs.
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.
LogicalAsofJoin	copy(RelTraitSet traitSet, RexNode conditionExpr, RexNode matchConditionExpr, RelNode left, RelNode right)
static LogicalAsofJoin	create(RelNode left, RelNode right, List<RelHint> hints, RexNode condition, RexNode matchCondition, JoinRelType joinType, com.google.common.collect.ImmutableList<RelDataTypeField> systemFieldList)	Creates a LogicalAsofJoin.
boolean	deepEquals(@Nullable Object obj)	Equality check for RelNode digest.
int	deepHashCode()	Compute hash code for RelNode digest.
com.google.common.collect.ImmutableList<RelDataTypeField>	getSystemFieldList()	Returns a list of system fields that will be prefixed to output row type.
RelNode	withHints(List<RelHint> hintList)	Returns a new relational expression with the specified hints hintList.

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

explainTerms, getMatchCondition

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

accept, analyzeCondition, computeSelfCost, createJoinType, deepEquals0, deepHashCode0, deriveJoinRowType, deriveRowType, estimateJoinedRows, estimateRowCount, getCondition, getHints, getJoinType, getVariablesSet, isSemiJoin, isSemiJoinDone, 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, stripped

Constructor Details

LogicalAsofJoin

public LogicalAsofJoin(RelOptCluster cluster,
 RelTraitSet traitSet,
 List<RelHint> hints,
 RelNode left,
 RelNode right,
 RexNode condition,
 RexNode matchCondition,
 JoinRelType joinType,
 com.google.common.collect.ImmutableList<RelDataTypeField> systemFieldList)

Creates a LogicalAsofJoin.

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, org.apache.calcite.rex.RexNode, org.apache.calcite.rel.core.JoinRelType, com.google.common.collect.ImmutableList<org.apache.calcite.rel.type.RelDataTypeField>) unless you know what you're doing.

Parameters:

cluster - Cluster

traitSet - Trait set

hints - Hints

left - Left input

right - Right input

condition - Join condition

matchCondition - Temporal condition

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

LogicalAsofJoin

public LogicalAsofJoin(RelInput input)

Creates a LogicalAsofJoin by parsing serialized output.

Method Details

create

public static LogicalAsofJoin create(RelNode left,
 RelNode right,
 List<RelHint> hints,
 RexNode condition,
 RexNode matchCondition,
 JoinRelType joinType,
 com.google.common.collect.ImmutableList<RelDataTypeField> systemFieldList)

Creates a LogicalAsofJoin.

copy

public LogicalAsofJoin copy(RelTraitSet traitSet,
 RexNode conditionExpr,
 RexNode matchConditionExpr,
 RelNode left,
 RelNode right)

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

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)

getSystemFieldList

public com.google.common.collect.ImmutableList<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

copy

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

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 Join

Parameters:

traitSet - Trait set

inputs - Inputs

Returns:

Copy of this relational expression, substituting traits and inputs

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