You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by GitBox <gi...@apache.org> on 2022/11/17 17:06:45 UTC
[GitHub] [spark] cloud-fan opened a new pull request, #38692: [SPARK-41183][SQL] Add an extension API to do plan normalization for caching
cloud-fan opened a new pull request, #38692:
URL: https://github.com/apache/spark/pull/38692
<!--
Thanks for sending a pull request! Here are some tips for you:
1. If this is your first time, please read our contributor guidelines: https://spark.apache.org/contributing.html
2. Ensure you have added or run the appropriate tests for your PR: https://spark.apache.org/developer-tools.html
3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][SPARK-XXXX] Your PR title ...'.
4. Be sure to keep the PR description updated to reflect all changes.
5. Please write your PR title to summarize what this PR proposes.
6. If possible, provide a concise example to reproduce the issue for a faster review.
7. If you want to add a new configuration, please read the guideline first for naming configurations in
'core/src/main/scala/org/apache/spark/internal/config/ConfigEntry.scala'.
8. If you want to add or modify an error type or message, please read the guideline first in
'core/src/main/resources/error/README.md'.
-->
### What changes were proposed in this pull request?
<!--
Please clarify what changes you are proposing. The purpose of this section is to outline the changes and how this PR fixes the issue.
If possible, please consider writing useful notes for better and faster reviews in your PR. See the examples below.
1. If you refactor some codes with changing classes, showing the class hierarchy will help reviewers.
2. If you fix some SQL features, you can provide some references of other DBMSes.
3. If there is design documentation, please add the link.
4. If there is a discussion in the mailing list, please add the link.
-->
Today, Spark is very conservative and uses the analyzed plan instead of the optimized plan as the cache key. Many cache opportunities are missed.
This PR updates `SparkSessionExtensions` to allow people to inject custom plan normalization rules. Users can pick some safe optimizer rules, or implement new rules based on their business needs, to do plan normalization and increase the cache hit rate.
### Why are the changes needed?
<!--
Please clarify why the changes are needed. For instance,
1. If you propose a new API, clarify the use case for a new API.
2. If you fix a bug, you can clarify why it is a bug.
-->
allow advanced users to do caching better.
### Does this PR introduce _any_ user-facing change?
<!--
Note that it means *any* user-facing change including all aspects such as the documentation fix.
If yes, please clarify the previous behavior and the change this PR proposes - provide the console output, description and/or an example to show the behavior difference if possible.
If possible, please also clarify if this is a user-facing change compared to the released Spark versions or within the unreleased branches such as master.
If no, write 'No'.
-->
no
### How was this patch tested?
<!--
If tests were added, say they were added here. Please make sure to add some test cases that check the changes thoroughly including negative and positive cases if possible.
If it was tested in a way different from regular unit tests, please clarify how you tested step by step, ideally copy and paste-able, so that other reviewers can test and check, and descendants can verify in the future.
If tests were not added, please describe why they were not added and/or why it was difficult to add.
If benchmark tests were added, please run the benchmarks in GitHub Actions for the consistent environment, and the instructions could accord to: https://spark.apache.org/developer-tools.html#github-workflow-benchmarks.
-->
new test
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] viirya commented on a diff in pull request #38692: [SPARK-41183][SQL] Add an extension API to do plan normalization for caching
Posted by GitBox <gi...@apache.org>.
viirya commented on code in PR #38692:
URL: https://github.com/apache/spark/pull/38692#discussion_r1026181826
##########
sql/core/src/main/scala/org/apache/spark/sql/execution/QueryExecution.scala:
##########
@@ -105,12 +105,30 @@ class QueryExecution(
case other => other
}
+ lazy val normalized: LogicalPlan = {
+ val normalizationRules = sparkSession.sessionState.planNormalizationRules
+ if (normalizationRules.isEmpty) {
+ commandExecuted
+ } else {
+ val planChangeLogger = new PlanChangeLogger[LogicalPlan]()
+ val normalized = normalizationRules.foldLeft(commandExecuted)((p, rule) => {
+ val result = rule.apply(p)
+ planChangeLogger.logRule(rule.ruleName, p, result)
+ result
+ })
+ if (normalizationRules.nonEmpty) {
Review Comment:
I think entering this `else` block means `normalizationRules` is non empty, no?
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] cloud-fan commented on a diff in pull request #38692: [SPARK-41183][SQL] Add an extension API to do plan normalization for caching
Posted by GitBox <gi...@apache.org>.
cloud-fan commented on code in PR #38692:
URL: https://github.com/apache/spark/pull/38692#discussion_r1026457875
##########
sql/core/src/test/scala/org/apache/spark/sql/SparkSessionExtensionSuite.scala:
##########
@@ -192,6 +192,23 @@ class SparkSessionExtensionSuite extends SparkFunSuite with SQLHelper {
testInjectColumnar(false)
}
+ test("inject plan normalization rules") {
+ val extensions = create { extensions =>
+ extensions.injectPlanNormalizationRules { session =>
+ org.apache.spark.sql.catalyst.optimizer.PushDownPredicates
+ }
+ }
+ withSession(extensions) { session =>
+ import session.implicits._
+ val df = Seq((1, "a"), (2, "b")).toDF("i", "s")
+ df.select("i").filter($"i" > 1).cache()
+ assert(df.filter($"i" > 1).select("i").queryExecution.executedPlan.find {
+ case _: org.apache.spark.sql.execution.columnar.InMemoryTableScanExec => true
+ case _ => false
Review Comment:
yup
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] ryan-johnson-databricks commented on a diff in pull request #38692: [SPARK-41183][SQL] Add an extension API to do plan normalization for caching
Posted by GitBox <gi...@apache.org>.
ryan-johnson-databricks commented on code in PR #38692:
URL: https://github.com/apache/spark/pull/38692#discussion_r1026804602
##########
sql/core/src/test/scala/org/apache/spark/sql/SparkSessionExtensionSuite.scala:
##########
@@ -192,6 +192,23 @@ class SparkSessionExtensionSuite extends SparkFunSuite with SQLHelper {
testInjectColumnar(false)
}
+ test("inject plan normalization rules") {
+ val extensions = create { extensions =>
+ extensions.injectPlanNormalizationRules { session =>
+ org.apache.spark.sql.catalyst.optimizer.PushDownPredicates
+ }
+ }
+ withSession(extensions) { session =>
+ import session.implicits._
+ val df = Seq((1, "a"), (2, "b")).toDF("i", "s")
+ df.select("i").filter($"i" > 1).cache()
+ assert(df.filter($"i" > 1).select("i").queryExecution.executedPlan.find {
+ case _: org.apache.spark.sql.execution.columnar.InMemoryTableScanExec => true
+ case _ => false
Review Comment:
Should we add a negative test that verifies this? Might be overkill...
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] cloud-fan closed pull request #38692: [SPARK-41183][SQL] Add an extension API to do plan normalization for caching
Posted by GitBox <gi...@apache.org>.
cloud-fan closed pull request #38692: [SPARK-41183][SQL] Add an extension API to do plan normalization for caching
URL: https://github.com/apache/spark/pull/38692
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] cloud-fan commented on pull request #38692: [SPARK-41183][SQL] Add an extension API to do plan normalization for caching
Posted by GitBox <gi...@apache.org>.
cloud-fan commented on PR #38692:
URL: https://github.com/apache/spark/pull/38692#issuecomment-1318943621
@viirya @wangyum @gengliangwang
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] cloud-fan commented on a diff in pull request #38692: [SPARK-41183][SQL] Add an extension API to do plan normalization for caching
Posted by GitBox <gi...@apache.org>.
cloud-fan commented on code in PR #38692:
URL: https://github.com/apache/spark/pull/38692#discussion_r1026569958
##########
sql/core/src/main/scala/org/apache/spark/sql/SparkSessionExtensions.scala:
##########
@@ -217,6 +218,22 @@ class SparkSessionExtensions {
checkRuleBuilders += builder
}
+ private[this] val planNormalizationRules = mutable.Buffer.empty[RuleBuilder]
+
+ def buildPlanNormalizationRules(session: SparkSession): Seq[Rule[LogicalPlan]] = {
+ planNormalizationRules.map(_.apply(session)).toSeq
Review Comment:
I'm following the existing code style in this file. I assume the reason is people who are not familiar with Scala may be confused when reading the code `.map(_(session))`
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] viirya commented on a diff in pull request #38692: [SPARK-41183][SQL] Add an extension API to do plan normalization for caching
Posted by GitBox <gi...@apache.org>.
viirya commented on code in PR #38692:
URL: https://github.com/apache/spark/pull/38692#discussion_r1026176496
##########
sql/core/src/test/scala/org/apache/spark/sql/SparkSessionExtensionSuite.scala:
##########
@@ -192,6 +192,23 @@ class SparkSessionExtensionSuite extends SparkFunSuite with SQLHelper {
testInjectColumnar(false)
}
+ test("inject plan normalization rules") {
+ val extensions = create { extensions =>
+ extensions.injectPlanNormalizationRules { session =>
+ org.apache.spark.sql.catalyst.optimizer.PushDownPredicates
+ }
+ }
+ withSession(extensions) { session =>
+ import session.implicits._
+ val df = Seq((1, "a"), (2, "b")).toDF("i", "s")
+ df.select("i").filter($"i" > 1).cache()
+ assert(df.filter($"i" > 1).select("i").queryExecution.executedPlan.find {
+ case _: org.apache.spark.sql.execution.columnar.InMemoryTableScanExec => true
+ case _ => false
Review Comment:
So without the added rule, caching is unable to apply here, right?
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] viirya commented on a diff in pull request #38692: [SPARK-41183][SQL] Add an extension API to do plan normalization for caching
Posted by GitBox <gi...@apache.org>.
viirya commented on code in PR #38692:
URL: https://github.com/apache/spark/pull/38692#discussion_r1026173073
##########
sql/core/src/main/scala/org/apache/spark/sql/SparkSessionExtensions.scala:
##########
@@ -40,6 +40,7 @@ import org.apache.spark.sql.execution.{ColumnarRule, SparkPlan}
* <ul>
* <li>Analyzer Rules.</li>
* <li>Check Analysis Rules.</li>
+ * <li>Plan Normalization Rules.</li>
Review Comment:
Cache Plan Normalization Rules? Since it is used for cache only.
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] cloud-fan commented on pull request #38692: [SPARK-41183][SQL] Add an extension API to do plan normalization for caching
Posted by GitBox <gi...@apache.org>.
cloud-fan commented on PR #38692:
URL: https://github.com/apache/spark/pull/38692#issuecomment-1321487076
thanks for the review, merging to master!
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] viirya commented on a diff in pull request #38692: [SPARK-41183][SQL] Add an extension API to do plan normalization for caching
Posted by GitBox <gi...@apache.org>.
viirya commented on code in PR #38692:
URL: https://github.com/apache/spark/pull/38692#discussion_r1026174652
##########
sql/core/src/main/scala/org/apache/spark/sql/execution/QueryExecution.scala:
##########
@@ -105,12 +105,30 @@ class QueryExecution(
case other => other
}
+ lazy val normalized: LogicalPlan = {
Review Comment:
Perhaps adding some comments for this.
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] ryan-johnson-databricks commented on a diff in pull request #38692: [SPARK-41183][SQL] Add an extension API to do plan normalization for caching
Posted by GitBox <gi...@apache.org>.
ryan-johnson-databricks commented on code in PR #38692:
URL: https://github.com/apache/spark/pull/38692#discussion_r1026540525
##########
sql/core/src/main/scala/org/apache/spark/sql/SparkSessionExtensions.scala:
##########
@@ -217,6 +218,22 @@ class SparkSessionExtensions {
checkRuleBuilders += builder
}
+ private[this] val planNormalizationRules = mutable.Buffer.empty[RuleBuilder]
+
+ def buildPlanNormalizationRules(session: SparkSession): Seq[Rule[LogicalPlan]] = {
+ planNormalizationRules.map(_.apply(session)).toSeq
Review Comment:
nit: isn't `.apply(...)` redundant with just `(...)` ?
##########
sql/core/src/main/scala/org/apache/spark/sql/execution/QueryExecution.scala:
##########
@@ -105,12 +105,30 @@ class QueryExecution(
case other => other
}
+ lazy val normalized: LogicalPlan = {
+ val normalizationRules = sparkSession.sessionState.planNormalizationRules
+ if (normalizationRules.isEmpty) {
+ commandExecuted
+ } else {
+ val planChangeLogger = new PlanChangeLogger[LogicalPlan]()
+ val normalized = normalizationRules.foldLeft(commandExecuted)((p, rule) => {
Review Comment:
nit: `(... => { ... })` is equivalent to just `{ ... => ... }` in this context
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org