Package org.apache.flink.table.planner.plan.rules.logical

Class CorrelateSortToRankRule

java.lang.Object

org.apache.calcite.plan.RelOptRule

org.apache.calcite.plan.RelRule<CorrelateSortToRankRule.CorrelateSortToRankRuleConfig>

org.apache.flink.table.planner.plan.rules.logical.CorrelateSortToRankRule

@Enclosing
public class CorrelateSortToRankRule
extends org.apache.calcite.plan.RelRule<CorrelateSortToRankRule.CorrelateSortToRankRuleConfig>

Planner rule that rewrites sort correlation to a Rank. Typically, the following plan

 LogicalProject(state=[$0], name=[$1])
 +- LogicalCorrelate(correlation=[$cor0], joinType=[inner], requiredColumns=[{0}])
    :- LogicalAggregate(group=[{0}])
    :  +- LogicalProject(state=[$1])
    :     +- LogicalTableScan(table=[[default_catalog, default_database, cities]])
    +- LogicalSort(sort0=[$1], dir0=[DESC-nulls-last], fetch=[3])
       +- LogicalProject(name=[$0], pop=[$2])
          +- LogicalFilter(condition=[=($1, $cor0.state)])
             +- LogicalTableScan(table=[[default_catalog, default_database, cities]])
 

would be transformed to

 LogicalProject(state=[$0], name=[$1])
  +- LogicalProject(state=[$1], name=[$0], pop=[$2])
     +- LogicalRank(rankType=[ROW_NUMBER], rankRange=[rankStart=1, rankEnd=3],
          partitionBy=[$1], orderBy=[$2 DESC], select=[name=$0, state=$1, pop=$2])
        +- LogicalTableScan(table=[[default_catalog, default_database, cities]])
 

To match the Correlate, the LHS needs to be a global Aggregate on a scan, the RHS should be a Sort with an equal Filter predicate whose keys are same with the LHS grouping keys.

This rule can only be used in HepPlanner.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CorrelateSortToRankRule.CorrelateSortToRankRuleConfig	Rule configuration.

Nested classes/interfaces inherited from class org.apache.calcite.plan.RelRule

org.apache.calcite.plan.RelRule.Config, org.apache.calcite.plan.RelRule.Done, org.apache.calcite.plan.RelRule.MatchHandler<R extends org.apache.calcite.plan.RelOptRule>, org.apache.calcite.plan.RelRule.OperandBuilder, org.apache.calcite.plan.RelRule.OperandDetailBuilder<R extends org.apache.calcite.rel.RelNode>, org.apache.calcite.plan.RelRule.OperandTransform

Nested classes/interfaces inherited from class org.apache.calcite.plan.RelOptRule

org.apache.calcite.plan.RelOptRule.ConverterRelOptRuleOperand

Field Summary

Fields

Modifier and Type	Field	Description
static final CorrelateSortToRankRule	INSTANCE

Fields inherited from class org.apache.calcite.plan.RelRule

config

Fields inherited from class org.apache.calcite.plan.RelOptRule

description, operands, relBuilderFactory

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CorrelateSortToRankRule(CorrelateSortToRankRule.CorrelateSortToRankRuleConfig config)

Method Summary

Modifier and Type	Method	Description
boolean	matches(org.apache.calcite.plan.RelOptRuleCall call)
void	onMatch(org.apache.calcite.plan.RelOptRuleCall call)

Methods inherited from class org.apache.calcite.plan.RelOptRule

any, convert, convert, convertList, convertOperand, convertOperand, equals, equals, getOperand, getOperands, getOutConvention, getOutTrait, hashCode, none, operand, operand, operand, operand, operand, operandJ, operandJ, some, toString, unordered

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

INSTANCE

public static final CorrelateSortToRankRule INSTANCE

Constructor Details

CorrelateSortToRankRule

protected CorrelateSortToRankRule(CorrelateSortToRankRule.CorrelateSortToRankRuleConfig config)

Method Details

matches

public boolean matches(org.apache.calcite.plan.RelOptRuleCall call)

Overrides:

matches in class org.apache.calcite.plan.RelOptRule

onMatch

public void onMatch(org.apache.calcite.plan.RelOptRuleCall call)

Specified by:

onMatch in class org.apache.calcite.plan.RelOptRule