godfreyhe commented on a change in pull request #12866: URL: https://github.com/apache/flink/pull/12866#discussion_r454185646
########## File path: flink-table/flink-table-planner-blink/src/main/java/org/apache/flink/table/planner/plan/rules/logical/PushFilterIntoTableSourceScanRule.java ########## @@ -0,0 +1,203 @@ +/* + * 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.api.DataTypes; +import org.apache.flink.table.api.TableConfig; +import org.apache.flink.table.api.TableException; +import org.apache.flink.table.api.config.OptimizerConfigOptions; +import org.apache.flink.table.connector.source.DynamicTableSource; +import org.apache.flink.table.connector.source.abilities.SupportsFilterPushDown; +import org.apache.flink.table.expressions.CallExpression; +import org.apache.flink.table.expressions.Expression; +import org.apache.flink.table.expressions.ResolvedExpression; +import org.apache.flink.table.expressions.resolver.ExpressionResolver; +import org.apache.flink.table.planner.calcite.FlinkContext; +import org.apache.flink.table.planner.expressions.converter.ExpressionConverter; +import org.apache.flink.table.planner.plan.schema.FlinkPreparingTableBase; +import org.apache.flink.table.planner.plan.schema.TableSourceTable; +import org.apache.flink.table.planner.plan.stats.FlinkStatistic; +import org.apache.flink.table.planner.plan.utils.FlinkRelOptUtil; +import org.apache.flink.table.planner.plan.utils.RexNodeExtractor; + +import org.apache.calcite.plan.RelOptRule; +import org.apache.calcite.plan.RelOptRuleCall; +import org.apache.calcite.rel.core.Filter; +import org.apache.calcite.rel.core.TableScan; +import org.apache.calcite.rel.logical.LogicalTableScan; +import org.apache.calcite.rex.RexNode; +import org.apache.calcite.tools.RelBuilder; + +import java.util.Arrays; +import java.util.LinkedList; +import java.util.List; +import java.util.Optional; +import java.util.TimeZone; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +import scala.Tuple2; + +import static org.apache.flink.table.functions.BuiltInFunctionDefinitions.AND; + +/** + * Planner rule that tries to push a filter into a {@link LogicalTableScan}, which table is a {@link TableSourceTable}. + * And the table source in the table is a {@link SupportsFilterPushDown}. + */ +public class PushFilterIntoTableSourceScanRule extends RelOptRule { + public static final PushFilterIntoTableSourceScanRule INSTANCE = new PushFilterIntoTableSourceScanRule(); + + public PushFilterIntoTableSourceScanRule() { + super(operand(Filter.class, + operand(LogicalTableScan.class, none())), + "PushFilterIntoTableSourceScanRule"); + } + + @Override + public boolean matches(RelOptRuleCall call) { + TableConfig config = call.getPlanner().getContext().unwrap(FlinkContext.class).getTableConfig(); + if (!config.getConfiguration().getBoolean( + OptimizerConfigOptions.TABLE_OPTIMIZER_SOURCE_PREDICATE_PUSHDOWN_ENABLED)) { + return false; + } + + Filter filter = call.rel(0); + if (filter.getCondition() == null) { + return false; + } + + LogicalTableScan scan = call.rel(1); + TableSourceTable tableSourceTable = scan.getTable().unwrap(TableSourceTable.class); + //we can not push filter twice + return tableSourceTable != null + && tableSourceTable.tableSource() instanceof SupportsFilterPushDown + && !Arrays.stream(tableSourceTable.extraDigests()).anyMatch(str -> str.contains("filter")); + } + + @Override + public void onMatch(RelOptRuleCall call) { + Filter filter = call.rel(0); + LogicalTableScan scan = call.rel(1); + TableSourceTable table = scan.getTable().unwrap(TableSourceTable.class); + pushFilterIntoScan(call, filter, scan, table); + } + + private void pushFilterIntoScan( + RelOptRuleCall call, + Filter filter, + LogicalTableScan scan, + FlinkPreparingTableBase relOptTable) { + + RelBuilder relBuilder = call.builder(); + FlinkContext context = call.getPlanner().getContext().unwrap(FlinkContext.class); + int maxCnfNodeCount = FlinkRelOptUtil.getMaxCnfNodeCount(scan); + Tuple2<Expression[], RexNode[]> tuple2 = + RexNodeExtractor.extractConjunctiveConditions( + filter.getCondition(), + maxCnfNodeCount, + filter.getInput().getRowType().getFieldNames(), + relBuilder.getRexBuilder(), + context.getFunctionCatalog(), + context.getCatalogManager(), + TimeZone.getTimeZone(scan.getCluster().getPlanner().getContext() + .unwrap(FlinkContext.class).getTableConfig().getLocalTimeZone())); + Expression[] predicates = tuple2._1; + RexNode[] unconvertedRexNodes = tuple2._2; + if (predicates.length == 0) { + // no condition can be translated to expression + return; + } + + List<Expression> remainingPredicates = new LinkedList<>(); + remainingPredicates.addAll(Arrays.asList(predicates)); + //record size before applyFilters for update statistics + int originPredicatesSize = remainingPredicates.size(); + + //Update DynamicTableSource + TableSourceTable oldTableSourceTable = relOptTable.unwrap(TableSourceTable.class); + DynamicTableSource newTableSource = oldTableSourceTable.tableSource().copy(); + ExpressionResolver resolver = ExpressionResolver.resolverFor( + context.getTableConfig(), + name -> Optional.empty(), + context.getFunctionCatalog().asLookup(str -> { + throw new TableException("We should not need to lookup any expressions at this point"); + }), + context.getCatalogManager().getDataTypeFactory()) + .build(); + SupportsFilterPushDown.Result result = ((SupportsFilterPushDown) newTableSource).applyFilters(resolver.resolve(remainingPredicates)); Review comment: nit: wrap the line, it's too long ########## File path: flink-table/flink-table-planner-blink/src/main/java/org/apache/flink/table/planner/plan/rules/logical/PushFilterIntoTableSourceScanRule.java ########## @@ -0,0 +1,203 @@ +/* + * 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.api.DataTypes; +import org.apache.flink.table.api.TableConfig; +import org.apache.flink.table.api.TableException; +import org.apache.flink.table.api.config.OptimizerConfigOptions; +import org.apache.flink.table.connector.source.DynamicTableSource; +import org.apache.flink.table.connector.source.abilities.SupportsFilterPushDown; +import org.apache.flink.table.expressions.CallExpression; +import org.apache.flink.table.expressions.Expression; +import org.apache.flink.table.expressions.ResolvedExpression; +import org.apache.flink.table.expressions.resolver.ExpressionResolver; +import org.apache.flink.table.planner.calcite.FlinkContext; +import org.apache.flink.table.planner.expressions.converter.ExpressionConverter; +import org.apache.flink.table.planner.plan.schema.FlinkPreparingTableBase; +import org.apache.flink.table.planner.plan.schema.TableSourceTable; +import org.apache.flink.table.planner.plan.stats.FlinkStatistic; +import org.apache.flink.table.planner.plan.utils.FlinkRelOptUtil; +import org.apache.flink.table.planner.plan.utils.RexNodeExtractor; + +import org.apache.calcite.plan.RelOptRule; +import org.apache.calcite.plan.RelOptRuleCall; +import org.apache.calcite.rel.core.Filter; +import org.apache.calcite.rel.core.TableScan; +import org.apache.calcite.rel.logical.LogicalTableScan; +import org.apache.calcite.rex.RexNode; +import org.apache.calcite.tools.RelBuilder; + +import java.util.Arrays; +import java.util.LinkedList; +import java.util.List; +import java.util.Optional; +import java.util.TimeZone; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +import scala.Tuple2; + +import static org.apache.flink.table.functions.BuiltInFunctionDefinitions.AND; + +/** + * Planner rule that tries to push a filter into a {@link LogicalTableScan}, which table is a {@link TableSourceTable}. + * And the table source in the table is a {@link SupportsFilterPushDown}. + */ +public class PushFilterIntoTableSourceScanRule extends RelOptRule { + public static final PushFilterIntoTableSourceScanRule INSTANCE = new PushFilterIntoTableSourceScanRule(); + + public PushFilterIntoTableSourceScanRule() { + super(operand(Filter.class, + operand(LogicalTableScan.class, none())), + "PushFilterIntoTableSourceScanRule"); + } + + @Override + public boolean matches(RelOptRuleCall call) { + TableConfig config = call.getPlanner().getContext().unwrap(FlinkContext.class).getTableConfig(); + if (!config.getConfiguration().getBoolean( + OptimizerConfigOptions.TABLE_OPTIMIZER_SOURCE_PREDICATE_PUSHDOWN_ENABLED)) { + return false; + } + + Filter filter = call.rel(0); + if (filter.getCondition() == null) { + return false; + } + + LogicalTableScan scan = call.rel(1); + TableSourceTable tableSourceTable = scan.getTable().unwrap(TableSourceTable.class); + //we can not push filter twice + return tableSourceTable != null + && tableSourceTable.tableSource() instanceof SupportsFilterPushDown + && !Arrays.stream(tableSourceTable.extraDigests()).anyMatch(str -> str.contains("filter")); + } + + @Override + public void onMatch(RelOptRuleCall call) { + Filter filter = call.rel(0); + LogicalTableScan scan = call.rel(1); + TableSourceTable table = scan.getTable().unwrap(TableSourceTable.class); + pushFilterIntoScan(call, filter, scan, table); + } + + private void pushFilterIntoScan( + RelOptRuleCall call, + Filter filter, + LogicalTableScan scan, + FlinkPreparingTableBase relOptTable) { + + RelBuilder relBuilder = call.builder(); + FlinkContext context = call.getPlanner().getContext().unwrap(FlinkContext.class); + int maxCnfNodeCount = FlinkRelOptUtil.getMaxCnfNodeCount(scan); + Tuple2<Expression[], RexNode[]> tuple2 = + RexNodeExtractor.extractConjunctiveConditions( + filter.getCondition(), + maxCnfNodeCount, + filter.getInput().getRowType().getFieldNames(), + relBuilder.getRexBuilder(), + context.getFunctionCatalog(), + context.getCatalogManager(), + TimeZone.getTimeZone(scan.getCluster().getPlanner().getContext() + .unwrap(FlinkContext.class).getTableConfig().getLocalTimeZone())); + Expression[] predicates = tuple2._1; + RexNode[] unconvertedRexNodes = tuple2._2; + if (predicates.length == 0) { + // no condition can be translated to expression + return; + } + + List<Expression> remainingPredicates = new LinkedList<>(); + remainingPredicates.addAll(Arrays.asList(predicates)); + //record size before applyFilters for update statistics + int originPredicatesSize = remainingPredicates.size(); + + //Update DynamicTableSource + TableSourceTable oldTableSourceTable = relOptTable.unwrap(TableSourceTable.class); + DynamicTableSource newTableSource = oldTableSourceTable.tableSource().copy(); + ExpressionResolver resolver = ExpressionResolver.resolverFor( + context.getTableConfig(), + name -> Optional.empty(), + context.getFunctionCatalog().asLookup(str -> { + throw new TableException("We should not need to lookup any expressions at this point"); + }), + context.getCatalogManager().getDataTypeFactory()) + .build(); + SupportsFilterPushDown.Result result = ((SupportsFilterPushDown) newTableSource).applyFilters(resolver.resolve(remainingPredicates)); + + //record size after applyFilters for update statistics + int updatedPredicatesSize = result.getRemainingFilters().size(); + //set the newStatistic newTableSource and extraDigests + TableSourceTable newTableSourceTable = oldTableSourceTable.copy( + newTableSource, + getNewFlinkStatistic(oldTableSourceTable, originPredicatesSize, updatedPredicatesSize), + getNewExtraDigests(oldTableSourceTable, result.getAcceptedFilters()) + ); + TableScan newScan = new LogicalTableScan(scan.getCluster(), scan.getTraitSet(), scan.getHints(), newTableSourceTable); Review comment: use `LogicalTableScan.create` instead of `new LogicalTableScan` ########## File path: flink-table/flink-table-planner-blink/src/main/java/org/apache/flink/table/planner/plan/rules/logical/PushFilterIntoTableSourceScanRule.java ########## @@ -0,0 +1,203 @@ +/* + * 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.api.DataTypes; +import org.apache.flink.table.api.TableConfig; +import org.apache.flink.table.api.TableException; +import org.apache.flink.table.api.config.OptimizerConfigOptions; +import org.apache.flink.table.connector.source.DynamicTableSource; +import org.apache.flink.table.connector.source.abilities.SupportsFilterPushDown; +import org.apache.flink.table.expressions.CallExpression; +import org.apache.flink.table.expressions.Expression; +import org.apache.flink.table.expressions.ResolvedExpression; +import org.apache.flink.table.expressions.resolver.ExpressionResolver; +import org.apache.flink.table.planner.calcite.FlinkContext; +import org.apache.flink.table.planner.expressions.converter.ExpressionConverter; +import org.apache.flink.table.planner.plan.schema.FlinkPreparingTableBase; +import org.apache.flink.table.planner.plan.schema.TableSourceTable; +import org.apache.flink.table.planner.plan.stats.FlinkStatistic; +import org.apache.flink.table.planner.plan.utils.FlinkRelOptUtil; +import org.apache.flink.table.planner.plan.utils.RexNodeExtractor; + +import org.apache.calcite.plan.RelOptRule; +import org.apache.calcite.plan.RelOptRuleCall; +import org.apache.calcite.rel.core.Filter; +import org.apache.calcite.rel.core.TableScan; +import org.apache.calcite.rel.logical.LogicalTableScan; +import org.apache.calcite.rex.RexNode; +import org.apache.calcite.tools.RelBuilder; + +import java.util.Arrays; +import java.util.LinkedList; +import java.util.List; +import java.util.Optional; +import java.util.TimeZone; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +import scala.Tuple2; + +import static org.apache.flink.table.functions.BuiltInFunctionDefinitions.AND; + +/** + * Planner rule that tries to push a filter into a {@link LogicalTableScan}, which table is a {@link TableSourceTable}. + * And the table source in the table is a {@link SupportsFilterPushDown}. + */ +public class PushFilterIntoTableSourceScanRule extends RelOptRule { + public static final PushFilterIntoTableSourceScanRule INSTANCE = new PushFilterIntoTableSourceScanRule(); + + public PushFilterIntoTableSourceScanRule() { + super(operand(Filter.class, + operand(LogicalTableScan.class, none())), + "PushFilterIntoTableSourceScanRule"); + } + + @Override + public boolean matches(RelOptRuleCall call) { + TableConfig config = call.getPlanner().getContext().unwrap(FlinkContext.class).getTableConfig(); + if (!config.getConfiguration().getBoolean( + OptimizerConfigOptions.TABLE_OPTIMIZER_SOURCE_PREDICATE_PUSHDOWN_ENABLED)) { + return false; + } + + Filter filter = call.rel(0); + if (filter.getCondition() == null) { + return false; + } + + LogicalTableScan scan = call.rel(1); + TableSourceTable tableSourceTable = scan.getTable().unwrap(TableSourceTable.class); + //we can not push filter twice + return tableSourceTable != null + && tableSourceTable.tableSource() instanceof SupportsFilterPushDown + && !Arrays.stream(tableSourceTable.extraDigests()).anyMatch(str -> str.contains("filter")); Review comment: what if a table contain a field named `filter` ? use str.startWith("filter=[") ---------------------------------------------------------------- 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]
