Skip to content

[SPARK-35673][SQL] Fix user-defined hint and unrecognized hint in subquery. #32841

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
cfmcgrady wants to merge 3 commits into from
Closed

[SPARK-35673][SQL] Fix user-defined hint and unrecognized hint in subquery. #32841

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fe72228
[SPARK-35673][SQL] Fix user-defined hint and unrecognized hint in sub…
cfmcgrady Jun 9, 2021
b542543
checkAnalysis for UnresolvedHint
cfmcgrady Jun 10, 2021
94d22b2
typo
cfmcgrady Jun 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/analysis/CheckAnalysis.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,9 @@ trait CheckAnalysis extends PredicateHelper with LookupCatalog {
case u: UnresolvedRelation =>
u.failAnalysis(s"Table or view not found: ${u.multipartIdentifier.quoted}")

case u: UnresolvedHint =>
u.failAnalysis(s"Hint not found: ${u.name}")

case InsertIntoStatement(u: UnresolvedRelation, _, _, _, _, _) =>
u.failAnalysis(s"Table not found: ${u.multipartIdentifier.quoted}")

Expand Down
5 changes: 4 additions & 1 deletion sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/plans/logical/hints.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,10 @@ import org.apache.spark.sql.catalyst.trees.TreePattern.{TreePattern, UNRESOLVED_
case class UnresolvedHint(name: String, parameters: Seq[Any], child: LogicalPlan)
extends UnaryNode {

override lazy val resolved: Boolean = false
// we need it to be resolved so that the analyzer can continue to analyze the rest of the query
// plan.
override lazy val resolved: Boolean = child.resolved
Copy link
Contributor

@cloud-fan cloud-fan Jun 9, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add some comments to explain the reason: we need it to be resolved so that the analyzer can continue to analyze the rest of the query plan.

Copy link
Contributor

@cloud-fan cloud-fan Jun 9, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To make up for this change, let's add a check in CheckAnalysis and fail if the plan still contains UnresolvedHint after analysis.

Copy link
Contributor Author

@cfmcgrady cfmcgrady Jun 10, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's ok for me to add this check.
And note that in the build-in analyzer, all of UnresolvedHint will be removed by batch Remove Unresolved Hints.

Copy link
Contributor

@cloud-fan cloud-fan Jun 10, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea, it's just for sanity check, to make sure UnresolvedHint shouldn't exist after analysis.


override def output: Seq[Attribute] = child.output
final override val nodePatterns: Seq[TreePattern] = Seq(UNRESOLVED_HINT)

Expand Down
16 changes: 16 additions & 0 deletions sql/catalyst/src/test/scala/org/apache/spark/sql/catalyst/analysis/AnalysisErrorSuite.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -791,4 +791,20 @@ class AnalysisErrorSuite extends AnalysisTest {
assertAnalysisError(plan, s"Correlated column is not allowed in predicate ($msg)" :: Nil)
}
}

test("SPARK-35673: fail if the plan still contains UnresolvedHint after analysis") {
val hintName = "some_random_hint_that_does_not_exist"
val plan = UnresolvedHint(hintName, Seq.empty,
Project(Alias(Literal(1), "x")() :: Nil, OneRowRelation())
)
assert(plan.resolved)

val error = intercept[AnalysisException] {
SimpleAnalyzer.checkAnalysis(plan)
}
assert(error.message.contains(s"Hint not found: ${hintName}"))

// UnresolvedHint be removed by batch `Remove Unresolved Hints`
assertAnalysisSuccess(plan, true)
}
}
26 changes: 26 additions & 0 deletions sql/core/src/test/scala/org/apache/spark/sql/SparkSessionExtensionSuite.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,6 +370,32 @@ class SparkSessionExtensionSuite extends SparkFunSuite {
}
}
}

test("SPARK-35673: user-defined hint and unrecognized hint in subquery") {
withSession(Seq(_.injectPostHocResolutionRule(MyHintRule))) { session =>
// unrecognized hint
QueryTest.checkAnswer(
session.sql(
"""
|SELECT *
|FROM (
| SELECT /*+ some_random_hint_that_does_not_exist */ 42
|)
|""".stripMargin),
Row(42) :: Nil)

// user-defined hint
QueryTest.checkAnswer(
session.sql(
"""
|SELECT *
|FROM (
| SELECT /*+ CONVERT_TO_EMPTY */ 42
|)
|""".stripMargin),
Nil)
}
}
}

case class MyRule(spark: SparkSession) extends Rule[LogicalPlan] {
Expand Down