|
| 1 | +// Licensed to the Apache Software Foundation (ASF) under one |
| 2 | +// or more contributor license agreements. See the NOTICE file |
| 3 | +// distributed with this work for additional information |
| 4 | +// regarding copyright ownership. The ASF licenses this file |
| 5 | +// to you under the Apache License, Version 2.0 (the |
| 6 | +// "License"); you may not use this file except in compliance |
| 7 | +// with the License. You may obtain a copy of the License at |
| 8 | +// |
| 9 | +// http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | +// |
| 11 | +// Unless required by applicable law or agreed to in writing, |
| 12 | +// software distributed under the License is distributed on an |
| 13 | +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| 14 | +// KIND, either express or implied. See the License for the |
| 15 | +// specific language governing permissions and limitations |
| 16 | +// under the License. |
| 17 | + |
| 18 | +package org.apache.doris.nereids.rules.analysis; |
| 19 | + |
| 20 | +import org.apache.doris.nereids.exceptions.AnalysisException; |
| 21 | +import org.apache.doris.nereids.rules.Rule; |
| 22 | +import org.apache.doris.nereids.rules.RuleType; |
| 23 | +import org.apache.doris.nereids.trees.expressions.Expression; |
| 24 | +import org.apache.doris.nereids.trees.expressions.SearchExpression; |
| 25 | +import org.apache.doris.nereids.trees.expressions.functions.scalar.Search; |
| 26 | +import org.apache.doris.nereids.trees.plans.Plan; |
| 27 | +import org.apache.doris.nereids.trees.plans.logical.LogicalAggregate; |
| 28 | +import org.apache.doris.nereids.trees.plans.logical.LogicalFilter; |
| 29 | +import org.apache.doris.nereids.trees.plans.logical.LogicalOlapScan; |
| 30 | +import org.apache.doris.nereids.trees.plans.logical.LogicalProject; |
| 31 | + |
| 32 | +import com.google.common.collect.ImmutableList; |
| 33 | + |
| 34 | +import java.util.List; |
| 35 | + |
| 36 | +/** |
| 37 | + * Check search expression usage - search() can only be used in WHERE filters on single-table OLAP scans. |
| 38 | + * This rule validates that search() expressions only appear in supported contexts. |
| 39 | + * Must run in analysis phase before search() gets optimized away. |
| 40 | + */ |
| 41 | +public class CheckSearchUsage implements AnalysisRuleFactory { |
| 42 | + |
| 43 | + @Override |
| 44 | + public List<Rule> buildRules() { |
| 45 | + return ImmutableList.of( |
| 46 | + any().thenApply(ctx -> { |
| 47 | + Plan plan = ctx.root; |
| 48 | + checkPlanRecursively(plan); |
| 49 | + return plan; |
| 50 | + }).toRule(RuleType.CHECK_SEARCH_USAGE) |
| 51 | + ); |
| 52 | + } |
| 53 | + |
| 54 | + private void checkPlanRecursively(Plan plan) { |
| 55 | + // Check if current plan node contains search expressions |
| 56 | + if (containsSearchInPlanExpressions(plan)) { |
| 57 | + validateSearchUsage(plan); |
| 58 | + } |
| 59 | + |
| 60 | + // Check aggregate nodes specifically for GROUP BY usage |
| 61 | + if (plan instanceof LogicalAggregate) { |
| 62 | + LogicalAggregate<?> agg = (LogicalAggregate<?>) plan; |
| 63 | + for (Expression expr : agg.getGroupByExpressions()) { |
| 64 | + if (containsSearchExpression(expr)) { |
| 65 | + throw new AnalysisException("search() cannot appear in GROUP BY expressions; " |
| 66 | + + "search predicates are only supported in WHERE filters on single-table scans"); |
| 67 | + } |
| 68 | + } |
| 69 | + for (Expression expr : agg.getOutputExpressions()) { |
| 70 | + if (containsSearchExpression(expr)) { |
| 71 | + throw new AnalysisException("search() cannot appear in aggregate output expressions; " |
| 72 | + + "search predicates are only supported in WHERE filters on single-table scans"); |
| 73 | + } |
| 74 | + } |
| 75 | + } |
| 76 | + |
| 77 | + // Check project nodes |
| 78 | + if (plan instanceof LogicalProject) { |
| 79 | + LogicalProject<?> project = (LogicalProject<?>) plan; |
| 80 | + for (Expression expr : project.getProjects()) { |
| 81 | + if (containsSearchExpression(expr)) { |
| 82 | + // Only allow if it's the project directly above a filter->scan pattern |
| 83 | + throw new AnalysisException("search() can only appear in WHERE filters on OLAP scans; " |
| 84 | + + "projection of search() is not supported"); |
| 85 | + } |
| 86 | + } |
| 87 | + } |
| 88 | + |
| 89 | + // Recursively check children |
| 90 | + for (Plan child : plan.children()) { |
| 91 | + checkPlanRecursively(child); |
| 92 | + } |
| 93 | + } |
| 94 | + |
| 95 | + private void validateSearchUsage(Plan plan) { |
| 96 | + if (plan instanceof LogicalFilter) { |
| 97 | + Plan child = plan.child(0); |
| 98 | + if (!(child instanceof LogicalOlapScan)) { |
| 99 | + throw new AnalysisException("search() predicate only supports filtering directly on a single " |
| 100 | + + "table scan; remove joins, subqueries, or additional operators between search() " |
| 101 | + + "and the target table"); |
| 102 | + } |
| 103 | + } else if (!(plan instanceof LogicalProject)) { |
| 104 | + // search() can only appear in LogicalFilter or specific LogicalProject nodes |
| 105 | + throw new AnalysisException("search() predicates are only supported inside WHERE filters on " |
| 106 | + + "single-table scans"); |
| 107 | + } |
| 108 | + } |
| 109 | + |
| 110 | + private boolean containsSearchInPlanExpressions(Plan plan) { |
| 111 | + for (Expression expr : plan.getExpressions()) { |
| 112 | + if (containsSearchExpression(expr)) { |
| 113 | + return true; |
| 114 | + } |
| 115 | + } |
| 116 | + return false; |
| 117 | + } |
| 118 | + |
| 119 | + private boolean containsSearchExpression(Expression expression) { |
| 120 | + if (expression instanceof Search || expression instanceof SearchExpression) { |
| 121 | + return true; |
| 122 | + } |
| 123 | + for (Expression child : expression.children()) { |
| 124 | + if (containsSearchExpression(child)) { |
| 125 | + return true; |
| 126 | + } |
| 127 | + } |
| 128 | + return false; |
| 129 | + } |
| 130 | +} |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments