Jackie-Jiang commented on code in PR #10444: URL: https://github.com/apache/pinot/pull/10444#discussion_r1149869941
########## pinot-core/src/main/java/org/apache/pinot/core/query/optimizer/filter/BaseAndOrBooleanFilterOptimizer.java: ########## @@ -0,0 +1,141 @@ +/** + * 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.pinot.core.query.optimizer.filter; + +import java.util.List; +import javax.annotation.Nullable; +import org.apache.pinot.common.request.Expression; +import org.apache.pinot.common.request.ExpressionType; +import org.apache.pinot.common.request.Function; +import org.apache.pinot.common.request.Literal; +import org.apache.pinot.common.utils.request.RequestUtils; +import org.apache.pinot.spi.data.Schema; +import org.apache.pinot.sql.FilterKind; + + +/** + * This base class acts as a helper for any optimizer that is effectively removing filter conditions. + * It provides TRUE/FALSE literal classes that can be used to replace filter expressions that are always true/false. + * It provides an optimization implementation for AND/OR/NOT expressions. + */ +public abstract class BaseAndOrBooleanFilterOptimizer implements FilterOptimizer { + + protected static final Expression TRUE = RequestUtils.getLiteralExpression(true); + protected static final Expression FALSE = RequestUtils.getLiteralExpression(false); + + /** + * This recursively optimizes each part of the filter expression. For any AND/OR/NOT, + * we optimize each child, then we optimize the remaining statement. If there is only + * a child statement, we optimize that. + */ + @Override + public Expression optimize(Expression filterExpression, @Nullable Schema schema) { + if (!canBeOptimized(filterExpression, schema)) { + return filterExpression; + } + + Function function = filterExpression.getFunctionCall(); + List<Expression> operands = function.getOperands(); + FilterKind kind = FilterKind.valueOf(function.getOperator()); + switch (kind) { + case AND: + case OR: + case NOT: + // Recursively traverse the expression tree to find an operator node that can be rewritten. + operands.forEach(operand -> optimize(operand, schema)); + + // We have rewritten the child operands, so rewrite the parent if needed. + return optimizeCurrent(filterExpression); + default: + return optimizeChild(filterExpression, schema); + } + } + + abstract boolean canBeOptimized(Expression filterExpression, @Nullable Schema schema); + + /** + * Optimize any cases that are not AND/OR/NOT. This should be done by converting any cases + * that are always true to TRUE or always false to FALSE. + */ + abstract Expression optimizeChild(Expression filterExpression, @Nullable Schema schema); + + /** + * If any of the operands of AND function is "false", then the AND function itself is false and can be replaced with + * "false" literal. Otherwise, remove all the "true" operands of the AND function. Similarly, if any of the operands + * of OR function is "true", then the OR function itself is true and can be replaced with "true" literal. Otherwise, + * remove all the "false" operands of the OR function. + */ + protected Expression optimizeCurrent(Expression expression) { + Function function = expression.getFunctionCall(); + String operator = function.getOperator(); + List<Expression> operands = function.getOperands(); + if (operator.equals(FilterKind.AND.name())) { + // If any of the literal operands are always false, then replace AND function with FALSE. + for (Expression operand : operands) { + if (isAlwaysFalse(operand)) { + return FALSE; + } + } + + // Remove all Literal operands that are always true. + operands.removeIf(this::isAlwaysTrue); + if (operands.isEmpty()) { + return TRUE; + } + } else if (operator.equals(FilterKind.OR.name())) { + // If any of the literal operands are always true, then replace OR function with TRUE + for (Expression operand : operands) { + if (isAlwaysTrue(operand)) { + return TRUE; + } + } + + // Remove all Literal operands that are always false. + operands.removeIf(this::isAlwaysFalse); + if (operands.isEmpty()) { + return FALSE; + } + } else if (operator.equals(FilterKind.NOT.name())) { + assert operands.size() == 1; + Expression operand = operands.get(0); + if (isAlwaysTrue(operand)) { + return FALSE; + } + if (isAlwaysFalse(operand)) { + return TRUE; + } + } + return expression; + } + + private boolean isAlwaysFalse(Expression operand) { + return operand.equals(FALSE); + } + + private boolean isAlwaysTrue(Expression operand) { + return operand.equals(TRUE); + } + + /** Change the expression value to boolean literal with given value. */ + protected static void setExpressionToBoolean(Expression expression, boolean value) { Review Comment: Not introduced in this PR, but let's remove this method since we should avoid mutating an expression. We can use the constant `TRUE` and `FALSE` instead ########## pinot-core/src/main/java/org/apache/pinot/core/query/optimizer/filter/IdenticalPredicateFilterOptimizer.java: ########## @@ -0,0 +1,108 @@ +/** + * 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.pinot.core.query.optimizer.filter; + +import java.util.List; +import javax.annotation.Nullable; +import org.apache.pinot.common.request.Expression; +import org.apache.pinot.common.request.Function; +import org.apache.pinot.spi.data.Schema; +import org.apache.pinot.sql.FilterKind; + + +/** + * This optimizer converts all predicates where the left hand side == right hand side to + * a simple TRUE/FALSE literal value. While filters like, WHERE 1=1 OR "col1"="col1" are not + * typical, they end up expensive in Pinot because they are rewritten as A-A==0. + */ +public class IdenticalPredicateFilterOptimizer extends BaseAndOrBooleanFilterOptimizer { + + @Override + boolean canBeOptimized(Expression filterExpression, @Nullable Schema schema) { + // if there's no function call, there's no lhs or rhs + return filterExpression.getFunctionCall() != null; + } + + @Override + Expression optimizeChild(Expression filterExpression, @Nullable Schema schema) { + Function function = filterExpression.getFunctionCall(); + FilterKind kind = FilterKind.valueOf(function.getOperator()); + switch (kind) { + case EQUALS: + if (hasIdenticalLhsAndRhs(filterExpression)) { Review Comment: (minor) Directly pass the operands ########## pinot-core/src/main/java/org/apache/pinot/core/query/optimizer/filter/IdenticalPredicateFilterOptimizer.java: ########## @@ -0,0 +1,108 @@ +/** + * 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.pinot.core.query.optimizer.filter; + +import java.util.List; +import javax.annotation.Nullable; +import org.apache.pinot.common.request.Expression; +import org.apache.pinot.common.request.Function; +import org.apache.pinot.spi.data.Schema; +import org.apache.pinot.sql.FilterKind; + + +/** + * This optimizer converts all predicates where the left hand side == right hand side to + * a simple TRUE/FALSE literal value. While filters like, WHERE 1=1 OR "col1"="col1" are not + * typical, they end up expensive in Pinot because they are rewritten as A-A==0. + */ +public class IdenticalPredicateFilterOptimizer extends BaseAndOrBooleanFilterOptimizer { + + @Override + boolean canBeOptimized(Expression filterExpression, @Nullable Schema schema) { + // if there's no function call, there's no lhs or rhs + return filterExpression.getFunctionCall() != null; + } + + @Override + Expression optimizeChild(Expression filterExpression, @Nullable Schema schema) { + Function function = filterExpression.getFunctionCall(); + FilterKind kind = FilterKind.valueOf(function.getOperator()); + switch (kind) { + case EQUALS: + if (hasIdenticalLhsAndRhs(filterExpression)) { + setExpressionToBoolean(filterExpression, true); + } + break; + case NOT_EQUALS: + if (hasIdenticalLhsAndRhs(filterExpression)) { + setExpressionToBoolean(filterExpression, false); + } + break; + default: + break; + } + return filterExpression; + } + + /** + * Pinot queries of the WHERE 1 != 1 AND "col1" = "col2" variety are rewritten as + * 1-1 != 0 AND "col1"-"col2" = 0. Therefore, we check specifically for the case where Review Comment: The rewrite is already happening in `PredicateComparisonRewriter.updateFunctionExpression()`, so we might just compare the lhs and rhs there. Since we already get this implementation, we can add a TODO here and revisit later ########## pinot-core/src/main/java/org/apache/pinot/core/query/optimizer/filter/BaseAndOrBooleanFilterOptimizer.java: ########## @@ -0,0 +1,141 @@ +/** + * 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.pinot.core.query.optimizer.filter; + +import java.util.List; +import javax.annotation.Nullable; +import org.apache.pinot.common.request.Expression; +import org.apache.pinot.common.request.ExpressionType; +import org.apache.pinot.common.request.Function; +import org.apache.pinot.common.request.Literal; +import org.apache.pinot.common.utils.request.RequestUtils; +import org.apache.pinot.spi.data.Schema; +import org.apache.pinot.sql.FilterKind; + + +/** + * This base class acts as a helper for any optimizer that is effectively removing filter conditions. + * It provides TRUE/FALSE literal classes that can be used to replace filter expressions that are always true/false. + * It provides an optimization implementation for AND/OR/NOT expressions. + */ +public abstract class BaseAndOrBooleanFilterOptimizer implements FilterOptimizer { + + protected static final Expression TRUE = RequestUtils.getLiteralExpression(true); + protected static final Expression FALSE = RequestUtils.getLiteralExpression(false); + + /** + * This recursively optimizes each part of the filter expression. For any AND/OR/NOT, + * we optimize each child, then we optimize the remaining statement. If there is only + * a child statement, we optimize that. + */ + @Override + public Expression optimize(Expression filterExpression, @Nullable Schema schema) { + if (!canBeOptimized(filterExpression, schema)) { + return filterExpression; + } + + Function function = filterExpression.getFunctionCall(); + List<Expression> operands = function.getOperands(); + FilterKind kind = FilterKind.valueOf(function.getOperator()); + switch (kind) { + case AND: + case OR: + case NOT: + // Recursively traverse the expression tree to find an operator node that can be rewritten. + operands.forEach(operand -> optimize(operand, schema)); Review Comment: Let's use `replaceAll()` here so that it still works when the optimize is not applied inplace ########## pinot-core/src/main/java/org/apache/pinot/core/query/optimizer/filter/IdenticalPredicateFilterOptimizer.java: ########## @@ -0,0 +1,108 @@ +/** + * 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.pinot.core.query.optimizer.filter; + +import java.util.List; +import javax.annotation.Nullable; +import org.apache.pinot.common.request.Expression; +import org.apache.pinot.common.request.Function; +import org.apache.pinot.spi.data.Schema; +import org.apache.pinot.sql.FilterKind; + + +/** + * This optimizer converts all predicates where the left hand side == right hand side to + * a simple TRUE/FALSE literal value. While filters like, WHERE 1=1 OR "col1"="col1" are not + * typical, they end up expensive in Pinot because they are rewritten as A-A==0. + */ +public class IdenticalPredicateFilterOptimizer extends BaseAndOrBooleanFilterOptimizer { + + @Override + boolean canBeOptimized(Expression filterExpression, @Nullable Schema schema) { + // if there's no function call, there's no lhs or rhs + return filterExpression.getFunctionCall() != null; + } + + @Override + Expression optimizeChild(Expression filterExpression, @Nullable Schema schema) { + Function function = filterExpression.getFunctionCall(); + FilterKind kind = FilterKind.valueOf(function.getOperator()); + switch (kind) { + case EQUALS: + if (hasIdenticalLhsAndRhs(filterExpression)) { + setExpressionToBoolean(filterExpression, true); + } + break; + case NOT_EQUALS: + if (hasIdenticalLhsAndRhs(filterExpression)) { + setExpressionToBoolean(filterExpression, false); + } + break; + default: + break; + } + return filterExpression; + } + + /** + * Pinot queries of the WHERE 1 != 1 AND "col1" = "col2" variety are rewritten as + * 1-1 != 0 AND "col1"-"col2" = 0. Therefore, we check specifically for the case where + * the operand is set up in this fashion. + * + * We return false specifically after every check to ensure we're only continuing when + * the input looks as expected. Otherwise, it's easy to for one of the operand functions + * to return null and fail the query. + */ + private boolean hasIdenticalLhsAndRhs(Expression operand) { + Function function = operand.getFunctionCall(); + if (function == null) { + return false; + } + List<Expression> children = function.getOperands(); + boolean hasTwoChildren = children.size() == 2; Review Comment: (minor) Is there any case `EQ` or `NEQ` can have other than 2 children? We can probably make a precondition ########## pinot-core/src/main/java/org/apache/pinot/core/query/optimizer/filter/IdenticalPredicateFilterOptimizer.java: ########## @@ -0,0 +1,108 @@ +/** + * 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.pinot.core.query.optimizer.filter; + +import java.util.List; +import javax.annotation.Nullable; +import org.apache.pinot.common.request.Expression; +import org.apache.pinot.common.request.Function; +import org.apache.pinot.spi.data.Schema; +import org.apache.pinot.sql.FilterKind; + + +/** + * This optimizer converts all predicates where the left hand side == right hand side to + * a simple TRUE/FALSE literal value. While filters like, WHERE 1=1 OR "col1"="col1" are not + * typical, they end up expensive in Pinot because they are rewritten as A-A==0. + */ +public class IdenticalPredicateFilterOptimizer extends BaseAndOrBooleanFilterOptimizer { + + @Override + boolean canBeOptimized(Expression filterExpression, @Nullable Schema schema) { + // if there's no function call, there's no lhs or rhs + return filterExpression.getFunctionCall() != null; + } + + @Override + Expression optimizeChild(Expression filterExpression, @Nullable Schema schema) { + Function function = filterExpression.getFunctionCall(); + FilterKind kind = FilterKind.valueOf(function.getOperator()); + switch (kind) { + case EQUALS: + if (hasIdenticalLhsAndRhs(filterExpression)) { + setExpressionToBoolean(filterExpression, true); Review Comment: Directly return `TRUE`, same for the following ########## pinot-core/src/main/java/org/apache/pinot/core/query/optimizer/filter/BaseAndOrBooleanFilterOptimizer.java: ########## @@ -0,0 +1,141 @@ +/** + * 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.pinot.core.query.optimizer.filter; + +import java.util.List; +import javax.annotation.Nullable; +import org.apache.pinot.common.request.Expression; +import org.apache.pinot.common.request.ExpressionType; +import org.apache.pinot.common.request.Function; +import org.apache.pinot.common.request.Literal; +import org.apache.pinot.common.utils.request.RequestUtils; +import org.apache.pinot.spi.data.Schema; +import org.apache.pinot.sql.FilterKind; + + +/** + * This base class acts as a helper for any optimizer that is effectively removing filter conditions. + * It provides TRUE/FALSE literal classes that can be used to replace filter expressions that are always true/false. + * It provides an optimization implementation for AND/OR/NOT expressions. + */ +public abstract class BaseAndOrBooleanFilterOptimizer implements FilterOptimizer { + + protected static final Expression TRUE = RequestUtils.getLiteralExpression(true); + protected static final Expression FALSE = RequestUtils.getLiteralExpression(false); + + /** + * This recursively optimizes each part of the filter expression. For any AND/OR/NOT, + * we optimize each child, then we optimize the remaining statement. If there is only + * a child statement, we optimize that. + */ + @Override + public Expression optimize(Expression filterExpression, @Nullable Schema schema) { + if (!canBeOptimized(filterExpression, schema)) { + return filterExpression; + } + + Function function = filterExpression.getFunctionCall(); + List<Expression> operands = function.getOperands(); + FilterKind kind = FilterKind.valueOf(function.getOperator()); + switch (kind) { + case AND: + case OR: + case NOT: + // Recursively traverse the expression tree to find an operator node that can be rewritten. + operands.forEach(operand -> optimize(operand, schema)); + + // We have rewritten the child operands, so rewrite the parent if needed. + return optimizeCurrent(filterExpression); + default: + return optimizeChild(filterExpression, schema); + } + } + + abstract boolean canBeOptimized(Expression filterExpression, @Nullable Schema schema); + + /** + * Optimize any cases that are not AND/OR/NOT. This should be done by converting any cases + * that are always true to TRUE or always false to FALSE. + */ + abstract Expression optimizeChild(Expression filterExpression, @Nullable Schema schema); + + /** + * If any of the operands of AND function is "false", then the AND function itself is false and can be replaced with + * "false" literal. Otherwise, remove all the "true" operands of the AND function. Similarly, if any of the operands + * of OR function is "true", then the OR function itself is true and can be replaced with "true" literal. Otherwise, + * remove all the "false" operands of the OR function. + */ + protected Expression optimizeCurrent(Expression expression) { + Function function = expression.getFunctionCall(); + String operator = function.getOperator(); + List<Expression> operands = function.getOperands(); + if (operator.equals(FilterKind.AND.name())) { + // If any of the literal operands are always false, then replace AND function with FALSE. + for (Expression operand : operands) { + if (isAlwaysFalse(operand)) { + return FALSE; + } + } + + // Remove all Literal operands that are always true. + operands.removeIf(this::isAlwaysTrue); + if (operands.isEmpty()) { + return TRUE; + } + } else if (operator.equals(FilterKind.OR.name())) { + // If any of the literal operands are always true, then replace OR function with TRUE + for (Expression operand : operands) { + if (isAlwaysTrue(operand)) { + return TRUE; + } + } + + // Remove all Literal operands that are always false. + operands.removeIf(this::isAlwaysFalse); + if (operands.isEmpty()) { + return FALSE; + } + } else if (operator.equals(FilterKind.NOT.name())) { + assert operands.size() == 1; + Expression operand = operands.get(0); + if (isAlwaysTrue(operand)) { + return FALSE; + } + if (isAlwaysFalse(operand)) { + return TRUE; + } + } + return expression; + } + + private boolean isAlwaysFalse(Expression operand) { + return operand.equals(FALSE); + } + + private boolean isAlwaysTrue(Expression operand) { + return operand.equals(TRUE); + } Review Comment: (nit) Slightly more readable if we just inline them or rename to `isTrue()` and `isFalse()` -- 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: commits-unsubscr...@pinot.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@pinot.apache.org For additional commands, e-mail: commits-h...@pinot.apache.org
