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

Interface BeamRelNode

All Superinterfaces:

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

All Known Implementing Classes:

BeamAggregationRel, BeamCalcRel, BeamCoGBKJoinRel, BeamIntersectRel, BeamIOSinkRel, BeamIOSourceRel, BeamJoinRel, BeamMinusRel, BeamSideInputJoinRel, BeamSideInputLookupJoinRel, BeamSortRel, BeamUncollectRel, BeamUnionRel, BeamUnnestRel, BeamValuesRel

public interface BeamRelNode
extends org.apache.calcite.rel.RelNode

A RelNode that can also give a PTransform that implements the expression.

Nested Class Summary

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

org.apache.calcite.rel.RelNode.Context

Method Summary

Modifier and Type	Method and Description
BeamCostModel	beamComputeSelfCost(org.apache.calcite.plan.RelOptPlanner planner, org.apache.calcite.rel.metadata.RelMetadataQuery mq) This method is called by org.apache.beam.sdk.extensions.sql.impl.CalciteQueryPlanner.NonCumulativeCostImpl.
PTransform<PCollectionList<Row>,PCollection<Row>>	buildPTransform()
NodeStats	estimateNodeStats(org.apache.calcite.rel.metadata.RelMetadataQuery mq) This method is called by org.apache.beam.sdk.extensions.sql.impl.planner.RelMdNodeStats.
default java.util.List<org.apache.calcite.rel.RelNode>	getPCollectionInputs()
default java.util.Map<java.lang.String,java.lang.String>	getPipelineOptions() Perform a DFS(Depth-First-Search) to find the PipelineOptions config.
default PCollection.IsBounded	isBounded() Whether the collection of rows represented by this relational expression is bounded (known to be finite) or unbounded (may or may not be finite).

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

accept, accept, childrenAccept, collectVariablesSet, collectVariablesUsed, computeSelfCost, 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

Method Detail

isBounded

default PCollection.IsBounded isBounded()

Whether the collection of rows represented by this relational expression is bounded (known to be finite) or unbounded (may or may not be finite).

Returns:

bounded if and only if all PCollection inputs are bounded

getPCollectionInputs

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

buildPTransform

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

getPipelineOptions

default java.util.Map<java.lang.String,java.lang.String> getPipelineOptions()

Perform a DFS(Depth-First-Search) to find the PipelineOptions config.

estimateNodeStats

NodeStats estimateNodeStats(org.apache.calcite.rel.metadata.RelMetadataQuery mq)

This method is called by org.apache.beam.sdk.extensions.sql.impl.planner.RelMdNodeStats. This is currently only used in SQLTransform Path (and not JDBC path). When a RelNode wants to calculate its BeamCost or estimate its NodeStats, it may need NodeStat of its inputs. However, it should not call this directly (because maybe its inputs are not physical yet). It should call BeamSqlRelUtils.getNodeStats(org.apache.calcite.rel.RelNode, org.apache.calcite.rel.metadata.RelMetadataQuery) instead.

beamComputeSelfCost

BeamCostModel beamComputeSelfCost(org.apache.calcite.plan.RelOptPlanner planner,
                                  org.apache.calcite.rel.metadata.RelMetadataQuery mq)

This method is called by org.apache.beam.sdk.extensions.sql.impl.CalciteQueryPlanner.NonCumulativeCostImpl. This is currently only used in SQLTransform Path (and not JDBC path). This is needed when Calcite Query Planner wants to get the cost of a plan. Instead of calling this directly for a node, if we needed that it should be obtained by calling mq.getNonCumulativeCost. This way RelMetadataQuery will call this method instead of ComputeSelfCost if the handler is set correctly (see org.apache.beam.sdk.extensions.sql.impl.CalciteQueryPlanner#convertToBeamRel(String))