Package org.apache.calcite.adapter.enumerable

Class EnumerableBatchNestedLoopJoin

java.lang.Object

org.apache.calcite.rel.AbstractRelNode

org.apache.calcite.rel.BiRel

org.apache.calcite.rel.core.Join

org.apache.calcite.adapter.enumerable.EnumerableBatchNestedLoopJoin

All Implemented Interfaces:

Cloneable, EnumerableRel, RelOptNode, Hintable, PhysicalNode, RelNode

public class EnumerableBatchNestedLoopJoin
extends Join
implements EnumerableRel

Implementation of batch nested loop join in enumerable calling convention.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.calcite.adapter.enumerable.EnumerableRel

EnumerableRel.Prefer, EnumerableRel.Result

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

Modifier	Constructor	Description
protected	EnumerableBatchNestedLoopJoin(RelOptCluster cluster, RelTraitSet traits, RelNode left, RelNode right, RexNode condition, Set<CorrelationId> variablesSet, ImmutableBitSet requiredColumns, JoinRelType joinType)

Method Summary

Modifier and Type	Method	Description
@Nullable RelOptCost	computeSelfCost(RelOptPlanner planner, RelMetadataQuery mq)	Returns the cost of this plan (not including children).
EnumerableBatchNestedLoopJoin	copy(RelTraitSet traitSet, RexNode condition, RelNode left, RelNode right, JoinRelType joinType, boolean semiJoinDone)	Creates a copy of this join, overriding condition, system fields and inputs.
static EnumerableBatchNestedLoopJoin	create(RelNode left, RelNode right, RexNode condition, ImmutableBitSet requiredColumns, Set<CorrelationId> variablesSet, JoinRelType joinType)
@Nullable Pair<RelTraitSet,List<RelTraitSet>>	deriveTraits(RelTraitSet childTraits, int childId)	Derive traitset from child node, returns a pair of traits after traits derivation.
RelWriter	explainTerms(RelWriter pw)	Describes the inputs and attributes of this relational expression.
DeriveMode	getDeriveMode()	Returns mode of derivation.
EnumerableRel.Result	implement(EnumerableRelImplementor implementor, EnumerableRel.Prefer pref)	Creates a plan for this expression according to a calling convention.
@Nullable Pair<RelTraitSet,List<RelTraitSet>>	passThroughTraits(RelTraitSet required)	Pass required traitset from parent node to child nodes, returns a pair of traits after traits is passed down.

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

accept, analyzeCondition, copy, createJoinType, deepEquals0, deepHashCode0, deriveJoinRowType, deriveRowType, estimateJoinedRows, estimateRowCount, getCondition, getHints, getJoinType, getSystemFieldList, 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

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

derive, derive, passThrough

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

accept, accept, childrenAccept, collectVariablesSet, collectVariablesUsed, copy, deepEquals, deepHashCode, estimateRowCount, explain, explain, fieldIsNullable, getConvention, getCorrelVariable, getDigest, getExpectedInputRowType, getInput, getInputs, getRelDigest, getRelTypeName, getRowType, getTable, getVariablesSet, isEnforcer, isValid, metadata, onRegister, recomputeDigest, register, replaceInput, stripped

Methods inherited from interface org.apache.calcite.plan.RelOptNode

getCluster, getDescription, getId, getTraitSet

Constructor Details

EnumerableBatchNestedLoopJoin

protected EnumerableBatchNestedLoopJoin(RelOptCluster cluster,
 RelTraitSet traits,
 RelNode left,
 RelNode right,
 RexNode condition,
 Set<CorrelationId> variablesSet,
 ImmutableBitSet requiredColumns,
 JoinRelType joinType)

Method Details

create

public static EnumerableBatchNestedLoopJoin create(RelNode left,
 RelNode right,
 RexNode condition,
 ImmutableBitSet requiredColumns,
 Set<CorrelationId> variablesSet,
 JoinRelType joinType)

passThroughTraits

public @Nullable Pair<RelTraitSet,List<RelTraitSet>> passThroughTraits(RelTraitSet required)

Description copied from interface: PhysicalNode

Pass required traitset from parent node to child nodes, returns a pair of traits after traits is passed down.

Pair.left: the new traitset; Pair.right: the list of required traitsets for child nodes.

Specified by:

passThroughTraits in interface EnumerableRel

Specified by:

passThroughTraits in interface PhysicalNode

deriveTraits

public @Nullable Pair<RelTraitSet,List<RelTraitSet>> deriveTraits(RelTraitSet childTraits,
 int childId)

Description copied from interface: PhysicalNode

Derive traitset from child node, returns a pair of traits after traits derivation.

Pair.left: the new traitset; Pair.right: the list of required traitsets for child nodes.

Specified by:

deriveTraits in interface EnumerableRel

Specified by:

deriveTraits in interface PhysicalNode

getDeriveMode

public DeriveMode getDeriveMode()

Description copied from interface: PhysicalNode

Returns mode of derivation.

Specified by:

getDeriveMode in interface EnumerableRel

Specified by:

getDeriveMode in interface PhysicalNode

copy

public EnumerableBatchNestedLoopJoin copy(RelTraitSet traitSet,
 RexNode condition,
 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

condition - 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

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 Join

Parameters:

planner - Planner for cost calculation

mq - Metadata query

Returns:

Cost of this plan (not including 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

implement

public EnumerableRel.Result implement(EnumerableRelImplementor implementor,
 EnumerableRel.Prefer pref)

Description copied from interface: EnumerableRel

Creates a plan for this expression according to a calling convention.

Specified by:

implement in interface EnumerableRel

Parameters:

implementor - Implementor

pref - Preferred representation for rows in result expression

Returns:

Plan for this expression according to a calling convention