rionmonster commented on code in PR #27643: URL: https://github.com/apache/flink/pull/27643#discussion_r2841139561
########## flink-table/flink-table-planner/src/main/java/org/apache/flink/table/planner/plan/rules/physical/stream/ExpandWindowTableFunctionTransposeRule.java: ########## @@ -0,0 +1,363 @@ +/* + * 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.physical.stream; + +import org.apache.flink.table.planner.calcite.FlinkTypeFactory; +import org.apache.flink.table.planner.functions.sql.SqlWindowTableFunction; +import org.apache.flink.table.planner.plan.logical.TimeAttributeWindowingStrategy; +import org.apache.flink.table.planner.plan.metadata.FlinkRelMetadataQuery; +import org.apache.flink.table.planner.plan.nodes.FlinkConventions; +import org.apache.flink.table.planner.plan.nodes.physical.stream.StreamPhysicalCalc; +import org.apache.flink.table.planner.plan.nodes.physical.stream.StreamPhysicalExpand; +import org.apache.flink.table.planner.plan.nodes.physical.stream.StreamPhysicalWindowAggregate; +import org.apache.flink.table.planner.plan.nodes.physical.stream.StreamPhysicalWindowTableFunction; +import org.apache.flink.table.planner.plan.trait.RelWindowProperties; +import org.apache.flink.table.planner.plan.utils.WindowUtil; + +import org.apache.calcite.plan.RelOptCluster; +import org.apache.calcite.plan.RelOptRule; +import org.apache.calcite.plan.RelOptRuleCall; +import org.apache.calcite.plan.RelRule; +import org.apache.calcite.plan.RelTraitSet; +import org.apache.calcite.rel.RelNode; +import org.apache.calcite.rel.type.RelDataType; +import org.apache.calcite.rex.RexInputRef; +import org.apache.calcite.rex.RexLiteral; +import org.apache.calcite.rex.RexNode; +import org.apache.calcite.rex.RexProgram; +import org.apache.calcite.util.ImmutableBitSet; +import org.immutables.value.Value; + +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import java.util.Set; +import java.util.stream.Collectors; + +import scala.Tuple4; + +/** + * This rule transposes {@link StreamPhysicalExpand} past {@link StreamPhysicalWindowTableFunction} + * to make {@link PullUpWindowTableFunctionIntoWindowAggregateRule} can match the rel tree pattern + * and optimize them into {@link StreamPhysicalWindowAggregate}. + * + * <p>Example: + * + * <p>MyTable: a INT, c STRING, rowtime TIMESTAMP(3) + * + * <p>SQL: + * + * <pre>{@code + * SELECT + * window_start, + * window_end, + * count(distinct a), + * count(distinct c) + * FROM TABLE(TUMBLE(TABLE MyTable, DESCRIPTOR(rowtime), INTERVAL '15' MINUTE)) + * GROUP BY window_start, window_end + * }</pre> + * + * <p>We will get part of the initial physical plan like following: + * + * <pre>{@code + * WindowAggregate(groupBy=[$f4, $f5], window=[TUMBLE(win_start=[window_start], + * win_end=[window_end], size=[15 min])], select=[$f4, $f5, COUNT(DISTINCT a) FILTER $g_1 AS $f2, + * COUNT(DISTINCT c) FILTER $g_2 AS $f3, start('w$) AS window_start, end('w$) AS window_end]) + * +- Exchange(distribution=[hash[$f4, $f5]]) + * +- Calc(select=[window_start, window_end, a, c, $f4, $f5, =($e, 1) AS $g_1, =($e, 2) AS $g_2]) + * +- Expand(projects=[{window_start, window_end, a, c, $f4, null AS $f5, 1 AS $e}, + * {window_start, window_end, a, c, null AS $f4, $f5, 2 AS $e}]) + * +- Calc(select=[window_start, window_end, a, c, + * MOD(HASH_CODE(a), 1024) AS $f4, MOD(HASH_CODE(c), 1024) AS $f5]) + * +- WindowTableFunction(window=[TUMBLE(time_col=[rowtime], size=[15 min])]) + * }</pre> + * + * <p>However, it can't match {@link PullUpWindowTableFunctionIntoWindowAggregateRule}, because + * {@link StreamPhysicalWindowTableFunction} is not near {@link StreamPhysicalWindowAggregate}. So + * we need to transpose {@link StreamPhysicalExpand} past {@link StreamPhysicalWindowTableFunction} + * to make the part of rel tree like this which can be matched by {@link + * PullUpWindowTableFunctionIntoWindowAggregateRule}. + * + * <pre>{@code + * WindowAggregate(groupBy=[$f4, $f5], window=[TUMBLE(win_start=[window_start], + * win_end=[window_end], size=[15 min])], select=[$f4, $f5, COUNT(DISTINCT a) FILTER $g_1 AS $f2, + * COUNT(DISTINCT c) FILTER $g_2 AS $f3, start('w$) AS window_start, end('w$) AS window_end]) + * +- Exchange(distribution=[hash[$f4, $f5]]) + * +- Calc(select=[window_start, window_end, a, c, $f4, $f5, ($e = 1) AS $g_1, ($e = 2) AS $g_2]) + * +- WindowTableFunction(window=[TUMBLE(time_col=[rowtime], size=[15 min])]) + * +- Expand(...) + * }</pre> + */ [email protected] +public class ExpandWindowTableFunctionTransposeRule + extends RelRule< + ExpandWindowTableFunctionTransposeRule + .ExpandWindowTableFunctionTransposeRuleConfig> { + + public static final ExpandWindowTableFunctionTransposeRule INSTANCE = + ExpandWindowTableFunctionTransposeRule.ExpandWindowTableFunctionTransposeRuleConfig + .DEFAULT + .toRule(); + + protected ExpandWindowTableFunctionTransposeRule( + ExpandWindowTableFunctionTransposeRuleConfig config) { + super(config); + } + + @Override + public boolean matches(RelOptRuleCall call) { + StreamPhysicalExpand expand = call.rel(0); + StreamPhysicalCalc calc = call.rel(1); + FlinkRelMetadataQuery fmq = + FlinkRelMetadataQuery.reuseOrCreate(calc.getCluster().getMetadataQuery()); + + // condition and projection of Calc shouldn't contain calls on window columns, + // otherwise, we can't transpose WindowTVF and Calc + if (WindowUtil.calcContainsCallsOnWindowColumns(calc, fmq)) { + return false; + } + + // we only transpose WindowTVF when expand propagate window_start and window_end, + // otherwise, it's meaningless to transpose + RelWindowProperties expandWindowProps = fmq.getRelWindowProperties(expand); + return expandWindowProps != null + && !expandWindowProps.getWindowStartColumns().isEmpty() + && !expandWindowProps.getWindowEndColumns().isEmpty(); + } + + @Override + public void onMatch(RelOptRuleCall call) { + StreamPhysicalExpand expand = call.rel(0); + StreamPhysicalCalc calc = call.rel(1); + StreamPhysicalWindowTableFunction windowTVF = call.rel(2); + RelOptCluster cluster = expand.getCluster(); + FlinkRelMetadataQuery fmq = FlinkRelMetadataQuery.reuseOrCreate(cluster.getMetadataQuery()); + FlinkTypeFactory typeFactory = (FlinkTypeFactory) cluster.getTypeFactory(); + RelNode input = windowTVF.getInput(); + RelDataType inputRowType = input.getRowType(); + + RelTraitSet requiredInputTraitSet = + input.getTraitSet().replace(FlinkConventions.STREAM_PHYSICAL()); + RelNode newInput = RelOptRule.convert(input, requiredInputTraitSet); + + // ------------------------------------------------------------------------- + // 1. transpose Calc and WindowTVF, build the new Calc node (the top node) + // ------------------------------------------------------------------------- + ImmutableBitSet windowColumns = fmq.getRelWindowProperties(windowTVF).getWindowColumns(); + Tuple4<RexProgram, int[], Object, Object> programInfo = Review Comment: While this is a non-issue and clearly tied to Java–Scala interop, it does look like we lose some of the stronger typing specifically around the `newTimeField` and `timeFieldAdded `properties which gets erased and requires subsequent casts. Probably not a big deal overall, and likely a non-issue if/when the `WindowUtil` class makes a similar migration, but figured it was worth calling out. -- 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. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
