feat(sql): expose CTE scope to relation planners - #24755
Draft
geoffreyclaude wants to merge 1 commit into
Draft
Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #24755 +/- ##
==========================================
- Coverage 81.48% 81.48% -0.01%
==========================================
Files 1122 1122
Lines 404248 404256 +8
Branches 404248 404256 +8
==========================================
+ Hits 329390 329391 +1
- Misses 55547 55550 +3
- Partials 19311 19315 +4 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Which issue does this PR close?
Rationale for this change
RelationPlannerextensions run before DataFusion's built-in CTE lookup. That ordering is useful, but it leaves a name-based extension unable to tell that a CTE should win over a same-named table. Both plans can be valid, so the mistake is silent: the user asks for the CTE and gets the table instead.Downstream projects have had to rebuild this context themselves. For example, GlossQL collects CTE names in a pre-pass. Its comment captures the rough edge nicely: because the extension cannot ask DataFusion about the current scope, a CTE declared only inside one subquery may have to be treated as visible everywhere.
DataFusion already has the precise, lexical CTE scope while it plans the query. This PR makes that information available to the extension that needs it.
What changes are included in this PR?
RelationPlannerContext::get_cte(&TableReference), with a defaultNoneimplementation so existing custom context implementations remain source-compatible.PlannerContextCTE map."foo.bar"cannot collide with the qualified tablefoo.bar.numbersshadowsnumbers, but not a table-function call such asnumbers(10).The lookup remains opt-in. A planner with deliberately reserved names can keep intercepting them exactly as it does today.
Are these changes tested?
Yes. The integration tests cover:
I also ran
cargo fmt --all, the required all-target/all-feature Clippy command with warnings denied, and the documentation Prettier check.Are there any user-facing changes?
This adds a small public API for relation-planner authors. It is source-compatible because the trait method has a default implementation. Existing planners keep their current behavior until they opt into the CTE check; planners that do opt in can preserve normal SQL shadowing without re-parsing the statement.