wuchong commented on a change in pull request #14569: URL: https://github.com/apache/flink/pull/14569#discussion_r553145500
########## File path: flink-table/flink-table-planner-blink/src/main/java/org/apache/flink/table/planner/plan/nodes/exec/stream/StreamExecGroupWindowAggregate.java ########## @@ -0,0 +1,373 @@ +/* + * 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.nodes.exec.stream; + +import org.apache.flink.api.dag.Transformation; +import org.apache.flink.streaming.api.transformations.OneInputTransformation; +import org.apache.flink.table.api.TableConfig; +import org.apache.flink.table.api.TableException; +import org.apache.flink.table.data.RowData; +import org.apache.flink.table.expressions.FieldReferenceExpression; +import org.apache.flink.table.expressions.ValueLiteralExpression; +import org.apache.flink.table.planner.calcite.FlinkRelBuilder.PlannerNamedWindowProperty; +import org.apache.flink.table.planner.codegen.CodeGeneratorContext; +import org.apache.flink.table.planner.codegen.EqualiserCodeGenerator; +import org.apache.flink.table.planner.codegen.agg.AggsHandlerCodeGenerator; +import org.apache.flink.table.planner.delegation.PlannerBase; +import org.apache.flink.table.planner.expressions.PlannerWindowProperty; +import org.apache.flink.table.planner.plan.logical.LogicalWindow; +import org.apache.flink.table.planner.plan.logical.SessionGroupWindow; +import org.apache.flink.table.planner.plan.logical.SlidingGroupWindow; +import org.apache.flink.table.planner.plan.logical.TumblingGroupWindow; +import org.apache.flink.table.planner.plan.nodes.exec.ExecEdge; +import org.apache.flink.table.planner.plan.nodes.exec.ExecNode; +import org.apache.flink.table.planner.plan.nodes.exec.ExecNodeBase; +import org.apache.flink.table.planner.plan.utils.AggregateInfoList; +import org.apache.flink.table.planner.plan.utils.KeySelectorUtil; +import org.apache.flink.table.planner.plan.utils.WindowEmitStrategy; +import org.apache.flink.table.planner.utils.JavaScalaConversionUtil; +import org.apache.flink.table.runtime.generated.GeneratedClass; +import org.apache.flink.table.runtime.generated.GeneratedNamespaceAggsHandleFunction; +import org.apache.flink.table.runtime.generated.GeneratedNamespaceTableAggsHandleFunction; +import org.apache.flink.table.runtime.generated.GeneratedRecordEqualiser; +import org.apache.flink.table.runtime.keyselector.RowDataKeySelector; +import org.apache.flink.table.runtime.operators.window.CountWindow; +import org.apache.flink.table.runtime.operators.window.TimeWindow; +import org.apache.flink.table.runtime.operators.window.WindowOperator; +import org.apache.flink.table.runtime.operators.window.WindowOperatorBuilder; +import org.apache.flink.table.runtime.types.LogicalTypeDataTypeConverter; +import org.apache.flink.table.runtime.typeutils.InternalTypeInfo; +import org.apache.flink.table.types.DataType; +import org.apache.flink.table.types.logical.LogicalType; +import org.apache.flink.table.types.logical.RowType; + +import org.apache.calcite.rel.core.AggregateCall; +import org.apache.calcite.tools.RelBuilder; +import org.apache.commons.lang3.ArrayUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.time.Duration; +import java.util.Arrays; +import java.util.Collections; +import java.util.List; + +import static org.apache.flink.table.planner.plan.utils.AggregateUtil.hasRowIntervalType; +import static org.apache.flink.table.planner.plan.utils.AggregateUtil.hasTimeIntervalType; +import static org.apache.flink.table.planner.plan.utils.AggregateUtil.isProctimeAttribute; +import static org.apache.flink.table.planner.plan.utils.AggregateUtil.isRowtimeAttribute; +import static org.apache.flink.table.planner.plan.utils.AggregateUtil.isTableAggregate; +import static org.apache.flink.table.planner.plan.utils.AggregateUtil.toDuration; +import static org.apache.flink.table.planner.plan.utils.AggregateUtil.toLong; +import static org.apache.flink.table.planner.plan.utils.AggregateUtil.transformToStreamAggregateInfoList; + +/** Stream {@link ExecNode} for either group window aggregate or group window table aggregate. */ +public class StreamExecGroupWindowAggregate extends ExecNodeBase<RowData> + implements StreamExecNode<RowData> { + private static final Logger LOGGER = + LoggerFactory.getLogger(StreamExecGroupWindowAggregate.class); + + private final int[] grouping; + private final AggregateCall[] aggCalls; + private final LogicalWindow window; + private final PlannerNamedWindowProperty[] namedProperties; + private final int inputTimeFieldIndex; + private final WindowEmitStrategy emitStrategy; + private final boolean needRetraction; + private final String aggType; + + public StreamExecGroupWindowAggregate( + int[] grouping, + AggregateCall[] aggCalls, + LogicalWindow window, + PlannerNamedWindowProperty[] namedProperties, + int inputTimeFieldIndex, + WindowEmitStrategy emitStrategy, + boolean needRetraction, + String aggType, + ExecEdge inputEdge, + RowType outputType, + String description) { + super(Collections.singletonList(inputEdge), outputType, description); + this.grouping = grouping; + this.aggCalls = aggCalls; + this.window = window; + this.namedProperties = namedProperties; + this.inputTimeFieldIndex = inputTimeFieldIndex; + this.emitStrategy = emitStrategy; + this.needRetraction = needRetraction; + this.aggType = aggType; Review comment: I think `aggType` is a too generic name. It seems only be used for printing. Is it possible to eliminate it? Maybe we don't need to mention this is a TableAggregate or Aggregate, the important information is that this is a window. ########## File path: flink-table/flink-table-planner-blink/src/main/java/org/apache/flink/table/planner/plan/nodes/exec/stream/StreamExecGroupWindowAggregate.java ########## @@ -0,0 +1,373 @@ +/* + * 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.nodes.exec.stream; + +import org.apache.flink.api.dag.Transformation; +import org.apache.flink.streaming.api.transformations.OneInputTransformation; +import org.apache.flink.table.api.TableConfig; +import org.apache.flink.table.api.TableException; +import org.apache.flink.table.data.RowData; +import org.apache.flink.table.expressions.FieldReferenceExpression; +import org.apache.flink.table.expressions.ValueLiteralExpression; +import org.apache.flink.table.planner.calcite.FlinkRelBuilder.PlannerNamedWindowProperty; +import org.apache.flink.table.planner.codegen.CodeGeneratorContext; +import org.apache.flink.table.planner.codegen.EqualiserCodeGenerator; +import org.apache.flink.table.planner.codegen.agg.AggsHandlerCodeGenerator; +import org.apache.flink.table.planner.delegation.PlannerBase; +import org.apache.flink.table.planner.expressions.PlannerWindowProperty; +import org.apache.flink.table.planner.plan.logical.LogicalWindow; +import org.apache.flink.table.planner.plan.logical.SessionGroupWindow; +import org.apache.flink.table.planner.plan.logical.SlidingGroupWindow; +import org.apache.flink.table.planner.plan.logical.TumblingGroupWindow; +import org.apache.flink.table.planner.plan.nodes.exec.ExecEdge; +import org.apache.flink.table.planner.plan.nodes.exec.ExecNode; +import org.apache.flink.table.planner.plan.nodes.exec.ExecNodeBase; +import org.apache.flink.table.planner.plan.utils.AggregateInfoList; +import org.apache.flink.table.planner.plan.utils.KeySelectorUtil; +import org.apache.flink.table.planner.plan.utils.WindowEmitStrategy; +import org.apache.flink.table.planner.utils.JavaScalaConversionUtil; +import org.apache.flink.table.runtime.generated.GeneratedClass; +import org.apache.flink.table.runtime.generated.GeneratedNamespaceAggsHandleFunction; +import org.apache.flink.table.runtime.generated.GeneratedNamespaceTableAggsHandleFunction; +import org.apache.flink.table.runtime.generated.GeneratedRecordEqualiser; +import org.apache.flink.table.runtime.keyselector.RowDataKeySelector; +import org.apache.flink.table.runtime.operators.window.CountWindow; +import org.apache.flink.table.runtime.operators.window.TimeWindow; +import org.apache.flink.table.runtime.operators.window.WindowOperator; +import org.apache.flink.table.runtime.operators.window.WindowOperatorBuilder; +import org.apache.flink.table.runtime.types.LogicalTypeDataTypeConverter; +import org.apache.flink.table.runtime.typeutils.InternalTypeInfo; +import org.apache.flink.table.types.DataType; +import org.apache.flink.table.types.logical.LogicalType; +import org.apache.flink.table.types.logical.RowType; + +import org.apache.calcite.rel.core.AggregateCall; +import org.apache.calcite.tools.RelBuilder; +import org.apache.commons.lang3.ArrayUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.time.Duration; +import java.util.Arrays; +import java.util.Collections; +import java.util.List; + +import static org.apache.flink.table.planner.plan.utils.AggregateUtil.hasRowIntervalType; +import static org.apache.flink.table.planner.plan.utils.AggregateUtil.hasTimeIntervalType; +import static org.apache.flink.table.planner.plan.utils.AggregateUtil.isProctimeAttribute; +import static org.apache.flink.table.planner.plan.utils.AggregateUtil.isRowtimeAttribute; +import static org.apache.flink.table.planner.plan.utils.AggregateUtil.isTableAggregate; +import static org.apache.flink.table.planner.plan.utils.AggregateUtil.toDuration; +import static org.apache.flink.table.planner.plan.utils.AggregateUtil.toLong; +import static org.apache.flink.table.planner.plan.utils.AggregateUtil.transformToStreamAggregateInfoList; + +/** Stream {@link ExecNode} for either group window aggregate or group window table aggregate. */ +public class StreamExecGroupWindowAggregate extends ExecNodeBase<RowData> + implements StreamExecNode<RowData> { + private static final Logger LOGGER = + LoggerFactory.getLogger(StreamExecGroupWindowAggregate.class); + + private final int[] grouping; + private final AggregateCall[] aggCalls; + private final LogicalWindow window; + private final PlannerNamedWindowProperty[] namedProperties; + private final int inputTimeFieldIndex; + private final WindowEmitStrategy emitStrategy; + private final boolean needRetraction; + private final String aggType; + + public StreamExecGroupWindowAggregate( + int[] grouping, + AggregateCall[] aggCalls, + LogicalWindow window, + PlannerNamedWindowProperty[] namedProperties, + int inputTimeFieldIndex, + WindowEmitStrategy emitStrategy, + boolean needRetraction, + String aggType, + ExecEdge inputEdge, + RowType outputType, + String description) { + super(Collections.singletonList(inputEdge), outputType, description); + this.grouping = grouping; + this.aggCalls = aggCalls; + this.window = window; + this.namedProperties = namedProperties; + this.inputTimeFieldIndex = inputTimeFieldIndex; + this.emitStrategy = emitStrategy; + this.needRetraction = needRetraction; + this.aggType = aggType; + } + + @SuppressWarnings("unchecked") + @Override + protected Transformation<RowData> translateToPlanInternal(PlannerBase planner) { + final TableConfig config = planner.getTableConfig(); + + final boolean isCountWindow; + if (window instanceof TumblingGroupWindow) { + isCountWindow = hasRowIntervalType(((TumblingGroupWindow) window).size()); + } else if (window instanceof SlidingGroupWindow) { + isCountWindow = hasRowIntervalType(((SlidingGroupWindow) window).size()); + } else { + isCountWindow = false; + } + + if (isCountWindow && grouping.length > 0 && config.getMinIdleStateRetentionTime() < 0) { + LOGGER.warn( + "No state retention interval configured for a query which accumulates state. " + + "Please provide a query configuration with valid retention interval to prevent " + + "excessive state size. You may specify a retention time of 0 to not clean up the state."); + } + + final ExecNode<RowData> inputNode = (ExecNode<RowData>) getInputNodes().get(0); + final Transformation<RowData> inputTransform = inputNode.translateToPlan(planner); + + final RowType inputRowType = (RowType) inputNode.getOutputType(); + + final int timeFieldIndex; + if (isRowtimeAttribute(window.timeAttribute())) { + if (inputTimeFieldIndex < 0) { + throw new TableException( + String.format( + "Group window %s must defined on a time attribute, " + + "but the time attribute can't be found.\n" + + "This should never happen. Please file an issue.", + aggType)); + } + timeFieldIndex = inputTimeFieldIndex; + } else { + timeFieldIndex = -1; + } + + final boolean[] aggCallNeedRetractions = new boolean[aggCalls.length]; + Arrays.fill(aggCallNeedRetractions, needRetraction); + final AggregateInfoList aggInfoList = + transformToStreamAggregateInfoList( + inputRowType, + JavaScalaConversionUtil.toScala(Arrays.asList(aggCalls)), + aggCallNeedRetractions, + needRetraction, + true, // isStateBackendDataViews + true); // needDistinctInfo + + final GeneratedClass<?> aggCodeGenerator = + createAggsHandler( + aggInfoList, config, planner.getRelBuilder(), inputRowType.getChildren()); + + final LogicalType[] aggResultTypes = extractLogicalTypes(aggInfoList.getActualValueTypes()); + final LogicalType[] windowPropertyTypes = + Arrays.stream(namedProperties) + .map(p -> p.property().resultType()) + .toArray(LogicalType[]::new); + + final EqualiserCodeGenerator generator = + new EqualiserCodeGenerator(ArrayUtils.addAll(aggResultTypes, windowPropertyTypes)); + final GeneratedRecordEqualiser equaliser = + generator.generateRecordEqualiser("WindowValueEqualiser"); + + final LogicalType[] aggValueTypes = extractLogicalTypes(aggInfoList.getActualValueTypes()); + final LogicalType[] accTypes = extractLogicalTypes(aggInfoList.getAccTypes()); + final WindowOperator<?, ?> operator = + createWindowOperator( + aggCodeGenerator, + equaliser, + accTypes, + windowPropertyTypes, + aggValueTypes, + inputRowType.getChildren().toArray(new LogicalType[0]), + timeFieldIndex); + + final OneInputTransformation<RowData, RowData> transform = + new OneInputTransformation<>( + inputTransform, + getDesc(), + operator, + InternalTypeInfo.of(getOutputType()), + inputTransform.getParallelism()); + + if (inputsContainSingleton()) { + transform.setParallelism(1); + transform.setMaxParallelism(1); + } + + // set KeyType and Selector for state + final RowDataKeySelector selector = + KeySelectorUtil.getRowDataSelector(grouping, InternalTypeInfo.of(inputRowType)); + transform.setStateKeySelector(selector); + transform.setStateKeyType(selector.getProducedType()); + return transform; + } + + private LogicalType[] extractLogicalTypes(DataType[] dataTypes) { + return Arrays.stream(dataTypes) + .map(LogicalTypeDataTypeConverter::fromDataTypeToLogicalType) + .toArray(LogicalType[]::new); + } + + private GeneratedClass<?> createAggsHandler( + AggregateInfoList aggInfoList, + TableConfig config, + RelBuilder relBuilder, + List<LogicalType> fieldTypes) { + final boolean needMerge; + final Class<?> windowClass; + if (window instanceof SlidingGroupWindow) { + ValueLiteralExpression size = ((SlidingGroupWindow) window).size(); + needMerge = hasTimeIntervalType(size); + windowClass = hasRowIntervalType(size) ? CountWindow.class : TimeWindow.class; + } else if (window instanceof TumblingGroupWindow) { + needMerge = false; + ValueLiteralExpression size = ((TumblingGroupWindow) window).size(); + windowClass = hasRowIntervalType(size) ? CountWindow.class : TimeWindow.class; + } else if (window instanceof SessionGroupWindow) { + needMerge = true; + windowClass = TimeWindow.class; + } else { + throw new TableException("Unsupported window: " + window.toString()); + } + + final AggsHandlerCodeGenerator generator = + new AggsHandlerCodeGenerator( + new CodeGeneratorContext(config), + relBuilder, + JavaScalaConversionUtil.toScala(fieldTypes), + false) // copyInputField + .needAccumulate(); + + if (needMerge) { + generator.needMerge(0, false, null); + } + if (needRetraction) { + generator.needRetract(); + } + + final List<PlannerWindowProperty> windowProperties = + Arrays.asList( + Arrays.stream(namedProperties) + .map(PlannerNamedWindowProperty::property) + .toArray(PlannerWindowProperty[]::new)); + final boolean isTableAggregate = + isTableAggregate(Arrays.asList(aggInfoList.getActualAggregateCalls())); + if (isTableAggregate) { + return generator.generateNamespaceTableAggsHandler( + "GroupingWindowTableAggsHandler", + aggInfoList, + JavaScalaConversionUtil.toScala(windowProperties), + windowClass); + } else { + return generator.generateNamespaceAggsHandler( + "GroupingWindowAggsHandler", + aggInfoList, + JavaScalaConversionUtil.toScala(windowProperties), + windowClass); + } + } + + private WindowOperator<?, ?> createWindowOperator( + GeneratedClass<?> aggsHandler, + GeneratedRecordEqualiser recordEqualiser, + LogicalType[] accTypes, + LogicalType[] windowPropertyTypes, + LogicalType[] aggValueTypes, + LogicalType[] inputFields, + int timeFieldIndex) { + WindowOperatorBuilder builder = + WindowOperatorBuilder.builder().withInputFields(inputFields); + + if (window instanceof TumblingGroupWindow) { + TumblingGroupWindow tumblingWindow = (TumblingGroupWindow) window; + FieldReferenceExpression timeField = tumblingWindow.timeField(); + ValueLiteralExpression size = tumblingWindow.size(); + if (isProctimeAttribute(timeField) && hasTimeIntervalType(size)) { + builder = builder.tumble(toDuration(size)).withProcessingTime(); + } else if (isRowtimeAttribute(timeField) && hasTimeIntervalType(size)) { + builder = builder.tumble(toDuration(size)).withEventTime(timeFieldIndex); + } else if (isProctimeAttribute(timeField) && hasRowIntervalType(size)) { + builder = builder.countWindow(toLong(size)); + } else { + // TODO: EventTimeTumblingGroupWindow should sort the stream on event time + // before applying the windowing logic. Otherwise, this would be the same as a + // ProcessingTimeTumblingGroupWindow + throw new UnsupportedOperationException( + "Event-time grouping windows on row intervals are currently not supported."); + } + } else if (window instanceof SlidingGroupWindow) { + SlidingGroupWindow slidingWindow = (SlidingGroupWindow) window; + FieldReferenceExpression timeField = slidingWindow.timeField(); + ValueLiteralExpression size = slidingWindow.size(); + ValueLiteralExpression slide = slidingWindow.slide(); + if (isProctimeAttribute(timeField) && hasTimeIntervalType(size)) { + builder = builder.sliding(toDuration(size), toDuration(slide)).withProcessingTime(); + } else if (isRowtimeAttribute(timeField) && hasTimeIntervalType(size)) { + builder = + builder.sliding(toDuration(size), toDuration(slide)) + .withEventTime(timeFieldIndex); + } else if (isProctimeAttribute(timeField) && hasRowIntervalType(size)) { + builder = builder.countWindow(toLong(size), toLong(slide)); + } else { + // TODO: EventTimeTumblingGroupWindow should sort the stream on event time + // before applying the windowing logic. Otherwise, this would be the same as a + // ProcessingTimeTumblingGroupWindow + throw new UnsupportedOperationException( + "Event-time grouping windows on row intervals are currently not supported."); + } + } else if (window instanceof SessionGroupWindow) { + SessionGroupWindow sessionWindow = (SessionGroupWindow) window; + FieldReferenceExpression timeField = sessionWindow.timeField(); + ValueLiteralExpression gap = sessionWindow.gap(); + if (isProctimeAttribute(timeField)) { + builder = builder.session(toDuration(gap)).withProcessingTime(); + } else if (isRowtimeAttribute(timeField)) { + builder = builder.session(toDuration(gap)).withEventTime(timeFieldIndex); + } else { + throw new UnsupportedOperationException("This should not happen."); + } + } else { + throw new TableException("Unsupported window: " + window.toString()); + } + + if (emitStrategy.produceUpdates()) { Review comment: The original implementation of `StreamExecGroupWindowTableAggregate` throws exception if `emitStrategy` produces updates. However, this check is removed now? Maybe we can throw this exception in `WindowOperatorBuilder` to keep this class unchanged. ---------------------------------------------------------------- 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: us...@infra.apache.org
