feat: parse JsonAccess as a binary operator, add Operator::Colon#20628
Merged
alamb merged 1 commit intoapache:mainfrom Mar 4, 2026
Merged
feat: parse JsonAccess as a binary operator, add Operator::Colon#20628alamb merged 1 commit intoapache:mainfrom
JsonAccess as a binary operator, add Operator::Colon#20628alamb merged 1 commit intoapache:mainfrom
Conversation
dba0816 to
cc55a52
Compare
- Needed in datafusion-contrib/datafusion-variant#26 - `sqlparser-rs` currently exposes the colon operator (`:`) as a special `JsonAccess` expression. So it fails in datafusion's parsing before an `ExprPlanner` is even invoked. - Fix it by converting `JsonAccess` to a normal binary expr, on which the `ExprPlanner` is invoked and custom parsing can be done. I have arrived at this solution iteratively to solve datafusion-contrib/datafusion-variant#26. Some alternatives I considered (but NOT IMPLEMENTED): - Add a new `Expr::JsonAccess` instead of re-using `BinaryExpr`. Alongside this, we could also introduce datafusion's version of a `JsonPath` struct. `Expr::JsonAccess` could also contain the optional cast that usually comes after it (like in `col_a:field_b::int`). The cast might be needed for performance optimizations. This is a much bigger change, so I have not done it.
cc55a52 to
da2c0b8
Compare
JsonAccess as a custom binary operatorJsonAccess as a binary operator
4 tasks
alamb
approved these changes
Mar 1, 2026
JsonAccess as a binary operatorJsonAccess as a binary operator, add Operator::Colon
Contributor
|
This PR introduces a breaking public API change (adding |
sdf-jkl
reviewed
Mar 3, 2026
Contributor
sdf-jkl
left a comment
There was a problem hiding this comment.
I'm not very familiar with this part of the codebase, but I’ve reviewed it and everything LGTM.
Contributor
Samyak2
added a commit
to Samyak2/datafusion
that referenced
this pull request
Mar 5, 2026
…tor::Colon` (apache#20628) Backport of apache#20628 on v53 branch. - Convert `JsonAccess` from sqlparser as a normal binary operator - Add `Operator::Colon` - Needed for datafusion-contrib/datafusion-variant#26
Contributor
Author
|
I'm not sure about the criteria a PR needs to meet to be backported. In case this PR does qualify, I have opened a PR here: #20717 |
Contributor
|
Given we haven't released branch-53 this is fine as it is a major release. When doing minor releases we can't backport API changes |
alamb
pushed a commit
that referenced
this pull request
Mar 5, 2026
…tor::Colon` (#20717) ## Which issue does this PR close? - part of #19692 <!-- We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax. For example `Closes #123` indicates that this PR will close issue #123. --> - Needed in datafusion-contrib/datafusion-variant#26 - Backport of #20628 on v53 branch. ## Rationale for this change <!-- Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed. Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes. --> - `sqlparser-rs` currently exposes the colon operator (`:`) as a special `JsonAccess` expression. So it fails in datafusion's parsing before an `ExprPlanner` is even invoked. - Add `Operator::Colon`. Currently it's not used/implemented in datafusion. ## What changes are included in this PR? <!-- There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR. --> - Fixes the above problem by converting `JsonAccess` to a normal binary expr, on which the `ExprPlanner` is invoked and custom parsing can be done. ## Are these changes tested? <!-- We typically require tests for all PRs in order to: 1. Prevent the code from being accidentally broken by subsequent changes 2. Serve as another way to document the expected behavior of the code If tests are not included in your PR, please explain why (for example, are they covered by existing tests)? --> Added tests. Also did a prototype of a custom `ExprPlanner` in datafusion-variant using this to convert colon operator to `variant_get` function - datafusion-contrib/datafusion-variant#31 ## Are there any user-facing changes? <!-- If there are user-facing changes then we may require documentation to be updated before approving the PR. --> <!-- If there are any breaking changes to public APIs, please add the `api change` label. --> Add `Operator::Colon`
Contributor
Author
|
Got it, thank you! |
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?
Needed in datafusion-contrib/datafusion-variant#26
Rationale for this change
sqlparser-rscurrently exposes the colon operator (:) as a specialJsonAccessexpression. So it fails in datafusion's parsing before anExprPlanneris even invoked.Operator::Colon. Currently it's not used/implemented in datafusion.What changes are included in this PR?
JsonAccessto a normal binary expr, on which theExprPlanneris invoked and custom parsing can be done.Are these changes tested?
Added tests.
Also did a prototype of a custom
ExprPlannerin datafusion-variant using this to convert colon operator tovariant_getfunction - datafusion-contrib/datafusion-variant#31Are there any user-facing changes?
Add
Operator::ColonAlternatives considered
I have arrived at this solution iteratively to solve datafusion-contrib/datafusion-variant#26. Some alternatives I considered (but NOT IMPLEMENTED):
Expr::JsonAccessinstead of re-usingBinaryExpr. Alongside this, we could also introduce datafusion's version of aJsonPathstruct.Expr::JsonAccesscould also contain the optional cast that usually comes after it (like incol_a:field_b::int). The cast might be needed for performance optimizations. This is a much bigger change, so I have not done it.If this makes sense to do at this time, please let me know and I will do those changes.