godfreyhe commented on a change in pull request #16024:
URL: https://github.com/apache/flink/pull/16024#discussion_r642744349
##########
File path:
flink-table/flink-table-planner-blink/src/main/scala/org/apache/flink/table/planner/plan/rules/FlinkStreamRuleSets.scala
##########
@@ -374,6 +374,8 @@ object FlinkStreamRuleSets {
PythonCorrelateSplitRule.INSTANCE,
// merge calc after calc transpose
FlinkCalcMergeRule.INSTANCE,
+ // remove output of rank number when it is not used by successor calc
+ RedundantRankNumberColumnRemoveRule.INSTANCE,
Review comment:
The solution for batch and stream are different ?
##########
File path:
flink-table/flink-table-planner-blink/src/main/scala/org/apache/flink/table/planner/plan/rules/FlinkBatchRuleSets.scala
##########
@@ -307,6 +307,9 @@ object FlinkBatchRuleSets {
CoreRules.PROJECT_TO_CALC,
FlinkCalcMergeRule.INSTANCE,
+ // remove output of rank number when it is not used by successor calc
+ RedundantRankNumberColumnRemoveRule.INSTANCE,
Review comment:
please move this rule close to other rank rules
##########
File path:
flink-table/flink-table-planner-blink/src/main/scala/org/apache/flink/table/planner/plan/rules/logical/RedundantRankNumberColumnRemoveRule.scala
##########
@@ -0,0 +1,90 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.flink.table.planner.plan.rules.logical
+
+import org.apache.flink.table.planner.plan.nodes.logical.{FlinkLogicalCalc,
FlinkLogicalRank}
+import org.apache.flink.table.planner.plan.utils.InputRefVisitor
+
+import org.apache.calcite.plan.RelOptRule.{any, operand}
+import org.apache.calcite.plan.{RelOptRule, RelOptRuleCall}
+import org.apache.calcite.rex.RexProgramBuilder
+
+import scala.collection.JavaConversions._
+
+/**
+ * Planner rule that removes the output column of rank number
+ * iff the rank number column is not used by successor calc.
+ */
+class RedundantRankNumberColumnRemoveRule
+ extends RelOptRule(
+ operand(classOf[FlinkLogicalCalc],
+ operand(classOf[FlinkLogicalRank], any())),
+ "RedundantRankNumberColumnRemoveRule") {
+
+ override def matches(call: RelOptRuleCall): Boolean = {
+ val calc: FlinkLogicalCalc = call.rel(0)
+ val rank: FlinkLogicalRank = call.rel(1)
+ val rankNumberColumnIdx = rank.getRowType.getFieldCount - 1
+ rank.outputRankNumber && !isFieldUsedByCalc(calc, rankNumberColumnIdx)
+ }
+
+ override def onMatch(call: RelOptRuleCall): Unit = {
+ val calc: FlinkLogicalCalc = call.rel(0)
+ val rank: FlinkLogicalRank = call.rel(1)
+ val newRank = new FlinkLogicalRank(
+ rank.getCluster,
+ rank.getTraitSet,
+ rank.getInput,
+ rank.partitionKey,
+ rank.orderKey,
+ rank.rankType,
+ rank.rankRange,
+ rank.rankNumberType,
+ outputRankNumber = false)
+
+ val rexBuilder = rank.getCluster.getRexBuilder
+ val oldProgram = calc.getProgram
+ val programBuilder = new RexProgramBuilder(newRank.getRowType, rexBuilder)
+ oldProgram.getNamedProjects.foreach { pair =>
+ programBuilder.addProject(oldProgram.expandLocalRef(pair.left),
pair.right)
+ }
+ if (oldProgram.getCondition != null) {
+
programBuilder.addCondition(oldProgram.expandLocalRef(oldProgram.getCondition))
+ }
+ val rexProgram = programBuilder.getProgram
Review comment:
we can use `RexProgramBuilder.create` to simplify these code
##########
File path:
flink-table/flink-table-planner-blink/src/main/scala/org/apache/flink/table/planner/plan/rules/logical/RedundantRankNumberColumnRemoveRule.scala
##########
@@ -0,0 +1,90 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.flink.table.planner.plan.rules.logical
+
+import org.apache.flink.table.planner.plan.nodes.logical.{FlinkLogicalCalc,
FlinkLogicalRank}
+import org.apache.flink.table.planner.plan.utils.InputRefVisitor
+
+import org.apache.calcite.plan.RelOptRule.{any, operand}
+import org.apache.calcite.plan.{RelOptRule, RelOptRuleCall}
+import org.apache.calcite.rex.RexProgramBuilder
+
+import scala.collection.JavaConversions._
+
+/**
+ * Planner rule that removes the output column of rank number
+ * iff the rank number column is not used by successor calc.
+ */
+class RedundantRankNumberColumnRemoveRule
+ extends RelOptRule(
+ operand(classOf[FlinkLogicalCalc],
+ operand(classOf[FlinkLogicalRank], any())),
+ "RedundantRankNumberColumnRemoveRule") {
+
+ override def matches(call: RelOptRuleCall): Boolean = {
+ val calc: FlinkLogicalCalc = call.rel(0)
+ val rank: FlinkLogicalRank = call.rel(1)
+ val rankNumberColumnIdx = rank.getRowType.getFieldCount - 1
Review comment:
actually, the result is wrong if `rank.outputRankNumber` is false
##########
File path:
flink-table/flink-table-planner-blink/src/main/scala/org/apache/flink/table/planner/plan/rules/logical/RedundantRankNumberColumnRemoveRule.scala
##########
@@ -0,0 +1,90 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.flink.table.planner.plan.rules.logical
+
+import org.apache.flink.table.planner.plan.nodes.logical.{FlinkLogicalCalc,
FlinkLogicalRank}
+import org.apache.flink.table.planner.plan.utils.InputRefVisitor
+
+import org.apache.calcite.plan.RelOptRule.{any, operand}
+import org.apache.calcite.plan.{RelOptRule, RelOptRuleCall}
+import org.apache.calcite.rex.RexProgramBuilder
+
+import scala.collection.JavaConversions._
+
+/**
+ * Planner rule that removes the output column of rank number
+ * iff the rank number column is not used by successor calc.
+ */
+class RedundantRankNumberColumnRemoveRule
+ extends RelOptRule(
+ operand(classOf[FlinkLogicalCalc],
+ operand(classOf[FlinkLogicalRank], any())),
+ "RedundantRankNumberColumnRemoveRule") {
+
+ override def matches(call: RelOptRuleCall): Boolean = {
+ val calc: FlinkLogicalCalc = call.rel(0)
+ val rank: FlinkLogicalRank = call.rel(1)
+ val rankNumberColumnIdx = rank.getRowType.getFieldCount - 1
+ rank.outputRankNumber && !isFieldUsedByCalc(calc, rankNumberColumnIdx)
+ }
+
+ override def onMatch(call: RelOptRuleCall): Unit = {
+ val calc: FlinkLogicalCalc = call.rel(0)
+ val rank: FlinkLogicalRank = call.rel(1)
+ val newRank = new FlinkLogicalRank(
+ rank.getCluster,
+ rank.getTraitSet,
+ rank.getInput,
+ rank.partitionKey,
+ rank.orderKey,
+ rank.rankType,
+ rank.rankRange,
+ rank.rankNumberType,
+ outputRankNumber = false)
+
+ val rexBuilder = rank.getCluster.getRexBuilder
+ val oldProgram = calc.getProgram
+ val programBuilder = new RexProgramBuilder(newRank.getRowType, rexBuilder)
+ oldProgram.getNamedProjects.foreach { pair =>
+ programBuilder.addProject(oldProgram.expandLocalRef(pair.left),
pair.right)
+ }
+ if (oldProgram.getCondition != null) {
+
programBuilder.addCondition(oldProgram.expandLocalRef(oldProgram.getCondition))
+ }
+ val rexProgram = programBuilder.getProgram
+ val newCalc = FlinkLogicalCalc.create(newRank, rexProgram)
+ call.transformTo(newCalc)
+ }
+
+ private def isFieldUsedByCalc(calc: FlinkLogicalCalc, inputRefIdx: Int):
Boolean = {
+ val projectsAndConditions = calc.getProgram.split()
+ val projects = projectsAndConditions.left
+ val conditions = projectsAndConditions.right
+ val visitor = new InputRefVisitor
+ // extract referenced input fields from projections
+ projects.foreach(exp => exp.accept(visitor))
+ // extract referenced input fields from condition
+ conditions.foreach(_.accept(visitor))
+ visitor.getFields.contains(inputRefIdx)
Review comment:
nit: we can also use `RelOptUtil.bits`
##########
File path:
flink-table/flink-table-planner-blink/src/test/scala/org/apache/flink/table/planner/plan/stream/sql/RankTest.scala
##########
@@ -705,5 +705,56 @@ class RankTest extends TableTestBase {
util.verifyExecPlan(sql)
}
+ @Test
+ def testRedundantRankNumberColumnRemove(): Unit = {
Review comment:
please add some tests for batch
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
