You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by "yhuang-db (via GitHub)" <gi...@apache.org> on 2025/10/06 20:26:44 UTC
[PR] [SPARK-53809][SQL]Add canonicalization for DSv2 scan [spark]
yhuang-db opened a new pull request, #52529:
URL: https://github.com/apache/spark/pull/52529
<!--
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
'common/utils/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.
-->
This PR proposes to add doCanonicalize function for DataSourceV2ScanRelation, as well as the Scan interface. The reason that a Scan needs a canonicalization is that the filters pushed to the scan may come in different order (while being identical in fact) during QO rewrite.
### 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.
-->
Query optimization rules such as MergeScalarSubqueries check if two plans are identical by [comparing their canonicalized form](https://issues.apache.org/jira/browse/SPARK-53809#L219). For DSv2, the comparison goes down to DataSourceV2ScanRelation in the hierarchy, which currently lacks of canonicalize function.
### Does this PR introduce _any_ user-facing change?
<!--
Note that it means *any* user-facing change including all aspects such as new features, bug fixes, or other behavior changes. Documentation-only updates are not considered user-facing changes.
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.
-->
todo
### Was this patch authored or co-authored using generative AI tooling?
<!--
If generative AI tooling has been used in the process of authoring this patch, please include the
phrase: 'Generated-by: ' followed by the name of the tool and its version.
If no, write 'No'.
Please refer to the [ASF Generative Tooling Guidance](https://www.apache.org/legal/generative-tooling.html) for details.
-->
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
Re: [PR] [SPARK-53809][SQL] Add canonicalization for DataSourceV2ScanRelation [spark]
Posted by "peter-toth (via GitHub)" <gi...@apache.org>.
peter-toth commented on PR #52529:
URL: https://github.com/apache/spark/pull/52529#issuecomment-3476039501
Thank you @yhuang-db for the fix.
Merged to `master` (4.1.0).
--
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
Re: [PR] [SPARK-53809][SQL]Add canonicalization for DataSourceV2ScanRelation [spark]
Posted by "yhuang-db (via GitHub)" <gi...@apache.org>.
yhuang-db commented on code in PR #52529:
URL: https://github.com/apache/spark/pull/52529#discussion_r2479445084
##########
sql/core/src/test/scala/org/apache/spark/sql/connector/DataSourceV2Suite.scala:
##########
@@ -1081,6 +1167,18 @@ class SimpleDataSourceV2 extends TestingV2Source {
override def planInputPartitions(): Array[InputPartition] = {
Array(RangeInputPartition(0, 5), RangeInputPartition(5, 10))
}
+
+ override def equals(obj: Any): Boolean = {
Review Comment:
`equals` needs to be implemented by scan itself.
Connector would have it own scan implementation, hence DataSourceV2ScanRelation cannot canonicalize the scan object by itself.
--
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
Re: [PR] [SPARK-53809][SQL]Add canonicalization for DataSourceV2ScanRelation [spark]
Posted by "yhuang-db (via GitHub)" <gi...@apache.org>.
yhuang-db commented on PR #52529:
URL: https://github.com/apache/spark/pull/52529#issuecomment-3473793115
Hi @peter-toth, I've added more description to justify the change and added tests to test the change. All checks have passed now. Please feel free to comment. Thanks!
--
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
Re: [PR] [SPARK-53809][SQL] Add canonicalization for DataSourceV2ScanRelation [spark]
Posted by "peter-toth (via GitHub)" <gi...@apache.org>.
peter-toth closed pull request #52529: [SPARK-53809][SQL] Add canonicalization for DataSourceV2ScanRelation
URL: https://github.com/apache/spark/pull/52529
--
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
Re: [PR] [SPARK-53809][SQL]Add canonicalization for DataSourceV2ScanRelation [spark]
Posted by "peter-toth (via GitHub)" <gi...@apache.org>.
peter-toth commented on code in PR #52529:
URL: https://github.com/apache/spark/pull/52529#discussion_r2481988611
##########
sql/core/src/test/scala/org/apache/spark/sql/connector/DataSourceV2Suite.scala:
##########
@@ -976,6 +979,89 @@ class DataSourceV2Suite extends QueryTest with SharedSparkSession with AdaptiveS
assert(result.length == 1)
}
}
+
+ test("SPARK-53809: scan canonicalization") {
+ val table = new SimpleDataSourceV2().getTable(CaseInsensitiveStringMap.empty())
+
+ def createDsv2ScanRelation(): DataSourceV2ScanRelation = {
+ val relation = DataSourceV2Relation.create(
+ table, None, None, CaseInsensitiveStringMap.empty())
+ val scan = relation.table.asReadable.newScanBuilder(relation.options).build()
+ DataSourceV2ScanRelation(relation, scan, relation.output)
+ }
+
+ // Create two DataSourceV2ScanRelation instances, representing the scan of the same table
+ val scanRelation1 = createDsv2ScanRelation()
+ val scanRelation2 = createDsv2ScanRelation()
+
+ // the two instances should not be the same, as they should have different attribute IDs
+ assert(scanRelation1 != scanRelation2,
+ "Two created DataSourceV2ScanRelation instances should not be the same")
+ assert(scanRelation1.output.map(_.exprId).toSet != scanRelation2.output.map(_.exprId).toSet,
+ "Output attributes should have different expression IDs before canonicalization")
+ assert(scanRelation1.relation.output.map(_.exprId).toSet !=
+ scanRelation2.relation.output.map(_.exprId).toSet,
+ "Relation output attributes should have different expression IDs before canonicalization")
+
+ // After canonicalization, the two instances should be equal
+ assert(scanRelation1.canonicalized == scanRelation2.canonicalized,
+ "Canonicalized DataSourceV2ScanRelation instances should be equal")
+ }
+
+ test("SPARK-53809: check mergeScalarSubqueries is effective for DataSourceV2ScanRelation") {
+ val df = spark.read.format(classOf[SimpleDataSourceV2].getName).load()
+ df.createOrReplaceTempView("df")
+
+ val query = sql("select (select max(i) from df) as max_i, (select min(i) from df) as min_i")
+ val optimizedPlan = query.queryExecution.optimizedPlan
+
+ // check optimizedPlan merged scalar subqueries `select max(i), min(i) from df`
+ val sub1 = optimizedPlan.asInstanceOf[Project].projectList.head.collect {
+ case s: ScalarSubquery => s
+ }
+ val sub2 = optimizedPlan.asInstanceOf[Project].projectList(1).collect {
+ case s: ScalarSubquery => s
+ }
+
+ // Both subqueries should reference the same merged plan `select max(i), min(i) from df`
+ assert(sub1.nonEmpty && sub2.nonEmpty, "Both scalar subqueries should exist")
+ assert(sub1.head.plan == sub2.head.plan,
+ "Both subqueries should reference the same merged plan")
+
+ // Extract the aggregate from the merged plan
+ val agg = sub1.head.plan.collect {
+ case a: Aggregate => a
+ }.head
+
+ // Check that the aggregate contains both max(i) and min(i)
+ val aggExprs = agg.aggregateExpressions
+
+ val hasMax = aggExprs.exists { expr =>
Review Comment:
Maybe it is better to extract the logic to the helper function or even better to just collect the aggregate functions to a collection and test it against the expected set.
--
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
Re: [PR] [SPARK-53809][SQL]Add canonicalization for DataSourceV2ScanRelation [spark]
Posted by "yhuang-db (via GitHub)" <gi...@apache.org>.
yhuang-db commented on code in PR #52529:
URL: https://github.com/apache/spark/pull/52529#discussion_r2479442860
##########
sql/core/src/test/scala/org/apache/spark/sql/connector/DataSourceV2Suite.scala:
##########
@@ -1081,6 +1167,18 @@ class SimpleDataSourceV2 extends TestingV2Source {
override def planInputPartitions(): Array[InputPartition] = {
Array(RangeInputPartition(0, 5), RangeInputPartition(5, 10))
}
+
Review Comment:
`equals` needs to be implemented by scan itself.
Connector would have it own scan implementation, hence DataSourceV2ScanRelation cannot canonicalize the scan object by itself.
--
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
Re: [PR] [SPARK-53809][SQL]Add canonicalization for DSv2 scan [spark]
Posted by "peter-toth (via GitHub)" <gi...@apache.org>.
peter-toth commented on PR #52529:
URL: https://github.com/apache/spark/pull/52529#issuecomment-3386122080
@yhuang-db , can you please check the test failures? Some of them seems related to your change.
--
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
Re: [PR] [SPARK-53809][SQL]Add canonicalization for DataSourceV2ScanRelation [spark]
Posted by "yhuang-db (via GitHub)" <gi...@apache.org>.
yhuang-db commented on code in PR #52529:
URL: https://github.com/apache/spark/pull/52529#discussion_r2479442860
##########
sql/core/src/test/scala/org/apache/spark/sql/connector/DataSourceV2Suite.scala:
##########
@@ -1081,6 +1167,18 @@ class SimpleDataSourceV2 extends TestingV2Source {
override def planInputPartitions(): Array[InputPartition] = {
Array(RangeInputPartition(0, 5), RangeInputPartition(5, 10))
}
+
Review Comment:
`equals` needs to be implemented by scan itself.
Connector would have it own scan implementation, hence DataSourceV2ScanRelation cannot canonicalize the scan object by itself.
--
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