[SPARK-33861][SQL] Simplify conditional in predicate #30865
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| /* | ||
| * 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.spark.sql.catalyst.optimizer | ||
|
|
||
| import org.apache.spark.sql.catalyst.expressions.{And, CaseWhen, Expression, If, Literal, Not, Or} | ||
| import org.apache.spark.sql.catalyst.expressions.Literal.{FalseLiteral, TrueLiteral} | ||
| import org.apache.spark.sql.catalyst.plans.logical._ | ||
| import org.apache.spark.sql.catalyst.rules.Rule | ||
| import org.apache.spark.sql.types.BooleanType | ||
| import org.apache.spark.util.Utils | ||
|
|
||
|
|
||
| object SimplifyConditionalsInPredicate extends Rule[LogicalPlan] { | ||
|
|
||
| def apply(plan: LogicalPlan): LogicalPlan = plan transform { | ||
| case f @ Filter(cond, _) => f.copy(condition = simplifyConditional(cond)) | ||
| case j @ Join(_, _, _, Some(cond), _) => j.copy(condition = Some(simplifyConditional(cond))) | ||
| case d @ DeleteFromTable(_, Some(cond)) => d.copy(condition = Some(simplifyConditional(cond))) | ||
| case u @ UpdateTable(_, _, Some(cond)) => u.copy(condition = Some(simplifyConditional(cond))) | ||
| } | ||
|
|
||
| private def simplifyConditional(e: Expression): Expression = e match { | ||
| case Literal(null, BooleanType) => FalseLiteral | ||
| case And(left, right) => And(simplifyConditional(left), simplifyConditional(right)) | ||
| case Or(left, right) => Or(simplifyConditional(left), simplifyConditional(right)) | ||
| case If(cond, t, FalseLiteral) => And(cond, t) | ||
| case If(cond, t, TrueLiteral) => Or(Not(cond), t) | ||
| case If(cond, FalseLiteral, f) => And(Not(cond), f) | ||
| case If(cond, TrueLiteral, f) => Or(cond, f) | ||
| case CaseWhen(Seq((cond, trueValue)), | ||
| Some(FalseLiteral) | Some(Literal(null, BooleanType)) | None) => | ||
| And(cond, trueValue) | ||
| case CaseWhen(Seq((cond, trueValue)), Some(TrueLiteral)) => | ||
| Or(Not(cond), trueValue) | ||
| case CaseWhen(Seq((cond, FalseLiteral)), elseValue) => | ||
| And(Not(cond), elseValue.getOrElse(Literal(null, BooleanType))) | ||
|
||
| case CaseWhen(Seq((cond, TrueLiteral)), elseValue) => | ||
| Or(cond, elseValue.getOrElse(Literal(null, BooleanType))) | ||
|
||
| case e if e.dataType == BooleanType => e | ||
|
Contributor
There was a problem hiding this comment. We can add an assert. The analyzer should guarantee it.
Contributor
There was a problem hiding this comment. I mean something like
Contributor
There was a problem hiding this comment. It seems the added assert can never be triggered. |
||
| case e => | ||
| val message = "Expected a Boolean type expression in simplifyConditional, " + | ||
| s"but got the type `${e.dataType.catalogString}` in `${e.sql}`." | ||
| if (Utils.isTesting) { | ||
| throw new IllegalArgumentException(message) | ||
| } else { | ||
| logWarning(message) | ||
| e | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,229 @@ | ||
| /* | ||
| * 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.spark.sql.catalyst.optimizer | ||
|
|
||
| import org.apache.spark.sql.AnalysisException | ||
| import org.apache.spark.sql.catalyst.analysis.UnresolvedAttribute | ||
| import org.apache.spark.sql.catalyst.dsl.expressions._ | ||
| import org.apache.spark.sql.catalyst.dsl.plans._ | ||
| import org.apache.spark.sql.catalyst.expressions.{And, CaseWhen, Expression, If, IsNotNull, Literal, Or} | ||
| import org.apache.spark.sql.catalyst.expressions.Literal.{FalseLiteral, TrueLiteral} | ||
| import org.apache.spark.sql.catalyst.plans.{Inner, PlanTest} | ||
| import org.apache.spark.sql.catalyst.plans.logical.{DeleteFromTable, LocalRelation, LogicalPlan, UpdateTable} | ||
| import org.apache.spark.sql.catalyst.rules.RuleExecutor | ||
| import org.apache.spark.sql.types.{BooleanType, IntegerType} | ||
|
|
||
| class SimplifyConditionalsInPredicateSuite extends PlanTest { | ||
|
|
||
| object Optimize extends RuleExecutor[LogicalPlan] { | ||
| val batches = | ||
| Batch("SimplifyConditionalsInPredicate", FixedPoint(10), | ||
| NullPropagation, | ||
| ConstantFolding, | ||
| BooleanSimplification, | ||
| SimplifyConditionals, | ||
| SimplifyConditionalsInPredicate) :: Nil | ||
| } | ||
|
|
||
| private val testRelation = | ||
| LocalRelation('i.int, 'b.boolean, 'a.array(IntegerType), 'm.map(IntegerType, IntegerType)) | ||
| private val anotherTestRelation = LocalRelation('d.int) | ||
|
|
||
| test("if(cond, trueVal, false) => And(cond, trueVal)") { | ||
| val originalCond = If( | ||
| UnresolvedAttribute("i") > Literal(10), | ||
| UnresolvedAttribute("b"), | ||
| FalseLiteral) | ||
| val expectedCond = And( | ||
| UnresolvedAttribute("i") > Literal(10), | ||
| UnresolvedAttribute("b")) | ||
| testFilter(originalCond, expectedCond = expectedCond) | ||
| testJoin(originalCond, expectedCond = expectedCond) | ||
| testDelete(originalCond, expectedCond = expectedCond) | ||
| testUpdate(originalCond, expectedCond = expectedCond) | ||
| testProjection(originalCond, expectedExpr = originalCond) | ||
| } | ||
|
|
||
| test("if(cond, trueVal, true) => or(not(cond), trueVal)") { | ||
| val originalCond = If( | ||
| UnresolvedAttribute("i") > Literal(10), | ||
| UnresolvedAttribute("b"), | ||
| TrueLiteral) | ||
| val expectedCond = Or( | ||
| UnresolvedAttribute("i") <= Literal(10), | ||
| UnresolvedAttribute("b")) | ||
| testFilter(originalCond, expectedCond = expectedCond) | ||
| testJoin(originalCond, expectedCond = expectedCond) | ||
| testDelete(originalCond, expectedCond = expectedCond) | ||
| testUpdate(originalCond, expectedCond = expectedCond) | ||
| testProjection(originalCond, expectedExpr = originalCond) | ||
| } | ||
|
|
||
| test("if(cond, false, falseVal) => and(not(cond), falseVal)") { | ||
| val originalCond = If( | ||
| UnresolvedAttribute("i") > Literal(10), | ||
| FalseLiteral, | ||
| UnresolvedAttribute("b")) | ||
| val expectedCond = And( | ||
| UnresolvedAttribute("i") <= Literal(10), | ||
| UnresolvedAttribute("b")) | ||
| testFilter(originalCond, expectedCond = expectedCond) | ||
| testJoin(originalCond, expectedCond = expectedCond) | ||
| testDelete(originalCond, expectedCond = expectedCond) | ||
| testUpdate(originalCond, expectedCond = expectedCond) | ||
| testProjection(originalCond, expectedExpr = originalCond) | ||
| } | ||
|
|
||
| test("if(cond, true, falseVal) => or(cond, falseVal)") { | ||
| val originalCond = If( | ||
| UnresolvedAttribute("i") > Literal(10), | ||
| TrueLiteral, | ||
| UnresolvedAttribute("b")) | ||
| val expectedCond = Or( | ||
| UnresolvedAttribute("i") > Literal(10), | ||
| UnresolvedAttribute("b")) | ||
| testFilter(originalCond, expectedCond = expectedCond) | ||
| testJoin(originalCond, expectedCond = expectedCond) | ||
| testDelete(originalCond, expectedCond = expectedCond) | ||
| testUpdate(originalCond, expectedCond = expectedCond) | ||
| testProjection(originalCond, expectedExpr = originalCond) | ||
| } | ||
|
|
||
|
|
||
| test("case when cond then trueVal else false end => And(cond, trueVal)") { | ||
| Seq(Some(FalseLiteral), None, Some(Literal(null, BooleanType))).foreach { elseExp => | ||
| val originalCond = CaseWhen( | ||
| Seq((UnresolvedAttribute("i") > Literal(10), UnresolvedAttribute("b"))), | ||
| elseExp) | ||
| val expectedCond = And( | ||
| UnresolvedAttribute("i") > Literal(10), | ||
| UnresolvedAttribute("b")) | ||
| testFilter(originalCond, expectedCond = expectedCond) | ||
| testJoin(originalCond, expectedCond = expectedCond) | ||
| testDelete(originalCond, expectedCond = expectedCond) | ||
| testUpdate(originalCond, expectedCond = expectedCond) | ||
| testProjection(originalCond, expectedExpr = originalCond) | ||
| } | ||
| } | ||
|
|
||
| test("case when cond then trueVal else true end => or(not(cond), trueVal)") { | ||
| val originalCond = CaseWhen( | ||
| Seq((UnresolvedAttribute("i") > Literal(10), UnresolvedAttribute("b"))), | ||
| TrueLiteral) | ||
| val expectedCond = Or( | ||
| UnresolvedAttribute("i") <= Literal(10), | ||
| UnresolvedAttribute("b")) | ||
| testFilter(originalCond, expectedCond = expectedCond) | ||
| testJoin(originalCond, expectedCond = expectedCond) | ||
| testDelete(originalCond, expectedCond = expectedCond) | ||
| testUpdate(originalCond, expectedCond = expectedCond) | ||
| testProjection(originalCond, expectedExpr = originalCond) | ||
| } | ||
|
|
||
| test("case when cond then false else elseValue end => and(not(cond), elseValue)") { | ||
| Seq() | ||
| val originalCond = CaseWhen( | ||
| Seq((UnresolvedAttribute("i") > Literal(10), FalseLiteral)), | ||
| UnresolvedAttribute("b")) | ||
| val expectedCond = And( | ||
| UnresolvedAttribute("i") <= Literal(10), | ||
| UnresolvedAttribute("b")) | ||
| testFilter(originalCond, expectedCond = expectedCond) | ||
| testJoin(originalCond, expectedCond = expectedCond) | ||
| testDelete(originalCond, expectedCond = expectedCond) | ||
| testUpdate(originalCond, expectedCond = expectedCond) | ||
| testProjection(originalCond, expectedExpr = originalCond) | ||
| } | ||
|
|
||
| test("case when cond then true else elseValue end => or(cond, elseValue)") { | ||
| val originalCond = CaseWhen( | ||
| Seq((UnresolvedAttribute("i") > Literal(10), TrueLiteral)), | ||
| UnresolvedAttribute("b")) | ||
| val expectedCond = Or( | ||
| UnresolvedAttribute("i") > Literal(10), | ||
| UnresolvedAttribute("b")) | ||
| testFilter(originalCond, expectedCond = expectedCond) | ||
| testJoin(originalCond, expectedCond = expectedCond) | ||
| testDelete(originalCond, expectedCond = expectedCond) | ||
| testUpdate(originalCond, expectedCond = expectedCond) | ||
| testProjection(originalCond, expectedExpr = originalCond) | ||
| } | ||
|
|
||
| test("case when cond then true end => or(cond, null)") { | ||
| val originalCond = CaseWhen( | ||
| Seq((UnresolvedAttribute("i") > Literal(10), TrueLiteral))) | ||
| val expectedCond = UnresolvedAttribute("i") > Literal(10) | ||
| testFilter(originalCond, expectedCond = expectedCond) | ||
| testJoin(originalCond, expectedCond = expectedCond) | ||
| testDelete(originalCond, expectedCond = expectedCond) | ||
| testUpdate(originalCond, expectedCond = expectedCond) | ||
| testProjection(originalCond, expectedExpr = originalCond) | ||
| } | ||
|
|
||
| test("Simplify conditional in conditions of CaseWhen inside another CaseWhen") { | ||
| val nestedCaseWhen = CaseWhen( | ||
| Seq((UnresolvedAttribute("i") > Literal(10)) -> UnresolvedAttribute("b")), | ||
| FalseLiteral) | ||
| val originalCond = CaseWhen(Seq(IsNotNull(nestedCaseWhen) -> FalseLiteral)) | ||
| val expectedCond = FalseLiteral | ||
|
|
||
| testFilter(originalCond, expectedCond = expectedCond) | ||
| testJoin(originalCond, expectedCond = expectedCond) | ||
| testDelete(originalCond, expectedCond = expectedCond) | ||
| testUpdate(originalCond, expectedCond = expectedCond) | ||
| testProjection(originalCond, expectedExpr = originalCond) | ||
| } | ||
|
|
||
| test("Not expected type - simplifyConditional") { | ||
| val e = intercept[AnalysisException] { | ||
| testFilter(originalCond = Literal(null, IntegerType), expectedCond = FalseLiteral) | ||
| }.getMessage | ||
| assert(e.contains("'CAST(NULL AS INT)' of type int is not a boolean")) | ||
| } | ||
|
|
||
| private def testFilter(originalCond: Expression, expectedCond: Expression): Unit = { | ||
| test((rel, exp) => rel.where(exp), originalCond, expectedCond) | ||
| } | ||
|
|
||
| private def testJoin(originalCond: Expression, expectedCond: Expression): Unit = { | ||
| test((rel, exp) => rel.join(anotherTestRelation, Inner, Some(exp)), originalCond, expectedCond) | ||
| } | ||
|
|
||
| private def testProjection(originalExpr: Expression, expectedExpr: Expression): Unit = { | ||
| test((rel, exp) => rel.select(exp), originalExpr, expectedExpr) | ||
| } | ||
|
|
||
| private def testDelete(originalCond: Expression, expectedCond: Expression): Unit = { | ||
| test((rel, expr) => DeleteFromTable(rel, Some(expr)), originalCond, expectedCond) | ||
| } | ||
|
|
||
| private def testUpdate(originalCond: Expression, expectedCond: Expression): Unit = { | ||
| test((rel, expr) => UpdateTable(rel, Seq.empty, Some(expr)), originalCond, expectedCond) | ||
| } | ||
|
|
||
| private def test( | ||
| func: (LogicalPlan, Expression) => LogicalPlan, | ||
| originalExpr: Expression, | ||
| expectedExpr: Expression): Unit = { | ||
|
|
||
| val originalPlan = func(testRelation, originalExpr).analyze | ||
| val optimizedPlan = Optimize.execute(originalPlan) | ||
| val expectedPlan = func(testRelation, expectedExpr).analyze | ||
| comparePlans(optimizedPlan, expectedPlan) | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.