org.apache.beam.sdk.extensions.sql.impl.rel

Class BeamJoinRel

java.lang.Object

org.apache.calcite.rel.AbstractRelNode

org.apache.calcite.rel.BiRel

org.apache.calcite.rel.core.Join

org.apache.beam.sdk.extensions.sql.impl.rel.BeamJoinRel

All Implemented Interfaces:

java.lang.Cloneable, BeamRelNode, org.apache.calcite.plan.RelOptNode, org.apache.calcite.rel.RelNode

public class BeamJoinRel
extends org.apache.calcite.rel.core.Join
implements BeamRelNode

BeamRelNode to replace a Join node.

Support for join can be categorized into 3 cases:

• BoundedTable JOIN BoundedTable
• UnboundedTable JOIN UnboundedTable
• BoundedTable JOIN UnboundedTable

For the first two cases, a standard join is utilized as long as the windowFn of the both sides match.

For the third case, sideInput is utilized to implement the join, so there are some constraints:

• FULL OUTER JOIN is not supported.
• If it's a LEFT OUTER JOIN, the unbounded table should on the left side.
• If it's a RIGHT OUTER JOIN, the unbounded table should on the right side.

There are also some general constraints:

• Only equi-join is supported.
• CROSS JOIN is not supported.

Nested Class Summary

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

org.apache.calcite.rel.RelNode.Context

Field Summary

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

condition, 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
BeamJoinRel(org.apache.calcite.plan.RelOptCluster cluster, org.apache.calcite.plan.RelTraitSet traits, org.apache.calcite.rel.RelNode left, org.apache.calcite.rel.RelNode right, org.apache.calcite.rex.RexNode condition, java.util.Set<org.apache.calcite.rel.core.CorrelationId> variablesSet, org.apache.calcite.rel.core.JoinRelType joinType)

Method Summary

Modifier and Type	Method and Description
PTransform<PCollectionList<Row>,PCollection<Row>>	buildPTransform()
org.apache.calcite.plan.RelOptCost	computeSelfCost(org.apache.calcite.plan.RelOptPlanner planner, org.apache.calcite.rel.metadata.RelMetadataQuery mq)
org.apache.calcite.rel.core.Join	copy(org.apache.calcite.plan.RelTraitSet traitSet, org.apache.calcite.rex.RexNode conditionExpr, org.apache.calcite.rel.RelNode left, org.apache.calcite.rel.RelNode right, org.apache.calcite.rel.core.JoinRelType joinType, boolean semiJoinDone)
java.util.List<org.apache.calcite.rel.RelNode>	getPCollectionInputs()
static boolean	isJoinLegal(org.apache.calcite.rel.core.Join join) This method checks if a join is legal and can be converted into Beam SQL.
PCollection<Row>	sideInputJoin(PCollection<KV<Row,Row>> extractedLeftRows, PCollection<KV<Row,Row>> extractedRightRows, Schema leftSchema, Schema rightSchema)

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

accept, analyzeCondition, copy, createJoinType, deriveJoinRowType, deriveRowType, estimateJoinedRows, estimateRowCount, explainTerms, getChildExps, getCondition, getJoinType, getSystemFieldList, getVariablesSet, 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, computeDigest, computeSelfCost, explain, getCluster, getCollationList, getConvention, getCorrelVariable, getDescription, getDigest, getExpectedInputRowType, getId, getInput, getQuery, getRelTypeName, getRows, getRowType, getTable, getTraitSet, getVariablesStopped, 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

Methods inherited from interface org.apache.beam.sdk.extensions.sql.impl.rel.BeamRelNode

getPipelineOptions, isBounded

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

accept, accept, childrenAccept, collectVariablesSet, collectVariablesUsed, computeSelfCost, copy, estimateRowCount, explain, getChildExps, getCollationList, getConvention, getCorrelVariable, getExpectedInputRowType, getInput, getInputs, getQuery, getRelTypeName, getRows, getRowType, getTable, getVariablesSet, getVariablesStopped, isDistinct, isKey, isValid, isValid, metadata, onRegister, recomputeDigest, register, replaceInput

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

getCluster, getDescription, getDigest, getId, getTraitSet

Constructor Detail

BeamJoinRel

public BeamJoinRel(org.apache.calcite.plan.RelOptCluster cluster,
                   org.apache.calcite.plan.RelTraitSet traits,
                   org.apache.calcite.rel.RelNode left,
                   org.apache.calcite.rel.RelNode right,
                   org.apache.calcite.rex.RexNode condition,
                   java.util.Set<org.apache.calcite.rel.core.CorrelationId> variablesSet,
                   org.apache.calcite.rel.core.JoinRelType joinType)

Method Detail

copy

public org.apache.calcite.rel.core.Join copy(org.apache.calcite.plan.RelTraitSet traitSet,
                                             org.apache.calcite.rex.RexNode conditionExpr,
                                             org.apache.calcite.rel.RelNode left,
                                             org.apache.calcite.rel.RelNode right,
                                             org.apache.calcite.rel.core.JoinRelType joinType,
                                             boolean semiJoinDone)

Specified by:

copy in class org.apache.calcite.rel.core.Join

getPCollectionInputs

public java.util.List<org.apache.calcite.rel.RelNode> getPCollectionInputs()

Specified by:

getPCollectionInputs in interface BeamRelNode

computeSelfCost

public org.apache.calcite.plan.RelOptCost computeSelfCost(org.apache.calcite.plan.RelOptPlanner planner,
                                                          org.apache.calcite.rel.metadata.RelMetadataQuery mq)

Specified by:

computeSelfCost in interface org.apache.calcite.rel.RelNode

Overrides:

computeSelfCost in class org.apache.calcite.rel.core.Join

isJoinLegal

public static boolean isJoinLegal(org.apache.calcite.rel.core.Join join)

This method checks if a join is legal and can be converted into Beam SQL. It is used during planning and applying BeamJoinAssociateRule and BeamJoinPushThroughJoinRule

buildPTransform

public PTransform<PCollectionList<Row>,PCollection<Row>> buildPTransform()

Specified by:

buildPTransform in interface BeamRelNode

sideInputJoin

public PCollection<Row> sideInputJoin(PCollection<KV<Row,Row>> extractedLeftRows,
                                      PCollection<KV<Row,Row>> extractedRightRows,
                                      Schema leftSchema,
                                      Schema rightSchema)