Documentation: Plan custom expressions #15353
Merged
Conversation
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
github-actions
bot
added
the
documentation
alamb
approved these changes
Mar 22, 2025
Contributor
alamb
left a comment
alamb
left a comment
There was a problem hiding this comment.
Thank you so much @Jiashu-Hu -- this looks great.
I have some suggestions on how to improve this section and example, but we could also do it as a follow on PR.
It is great to see the docs being improved
| ctx.register_expr_planner(Arc::new(MyCustomPlanner))?; | ||
| let results = ctx.sql("select 'foo'->'bar';").await?.collect().await?; | ||
|
|
||
| pretty::print_batches(&results)?; |
Contributor
There was a problem hiding this comment.
Could you please change this to use `assert_batches_eq! so the actual output is in the test and it is tested in CI
Contributor
Author
There was a problem hiding this comment.
Hi alamb, Thank you very much for your review! Yes, absolutely, I've updated it with an assert_batches_eq! in the latest commit.
Co-authored-by: Andrew Lamb <[email protected]>
Co-authored-by: Andrew Lamb <[email protected]>
Co-authored-by: Andrew Lamb <[email protected]>
Co-authored-by: Andrew Lamb <[email protected]>
Co-authored-by: Andrew Lamb <[email protected]>
added assert for CI process
qstommyshu
pushed a commit
to qstommyshu/datafusion
that referenced
this pull request
Mar 27, 2025
* Added Custom Expression Planning Section * improve syntax * Update docs/source/library-user-guide/adding-udfs.md Co-authored-by: Andrew Lamb <[email protected]> * Update docs/source/library-user-guide/adding-udfs.md Co-authored-by: Andrew Lamb <[email protected]> * Update docs/source/library-user-guide/adding-udfs.md Co-authored-by: Andrew Lamb <[email protected]> * Update docs/source/library-user-guide/adding-udfs.md Co-authored-by: Andrew Lamb <[email protected]> * Update docs/source/library-user-guide/adding-udfs.md Co-authored-by: Andrew Lamb <[email protected]> * Update adding-udfs.md added assert for CI process * formatted language request by prettier --------- Co-authored-by: Andrew Lamb <[email protected]>
nirnayroy
pushed a commit
to nirnayroy/datafusion
that referenced
this pull request
May 2, 2025
* Added Custom Expression Planning Section * improve syntax * Update docs/source/library-user-guide/adding-udfs.md Co-authored-by: Andrew Lamb <[email protected]> * Update docs/source/library-user-guide/adding-udfs.md Co-authored-by: Andrew Lamb <[email protected]> * Update docs/source/library-user-guide/adding-udfs.md Co-authored-by: Andrew Lamb <[email protected]> * Update docs/source/library-user-guide/adding-udfs.md Co-authored-by: Andrew Lamb <[email protected]> * Update docs/source/library-user-guide/adding-udfs.md Co-authored-by: Andrew Lamb <[email protected]> * Update adding-udfs.md added assert for CI process * formatted language request by prettier --------- Co-authored-by: Andrew Lamb <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
This PR adds documentation for using the
ExprPlannerAPI to plan custom expressions, as requested in #15267. Clear documentation with an example will help users extend DataFusion to support custom operators like PostgreSQL's->.What changes are included in this PR?
## Custom Expression Planningto documentExprPlannerdoes and why it’s useful.ExprPlannerto make the->operator concatenate strings (e.g.,'foo'->'bar'outputsfoobar).ExprPlannerandFunctionRegistry) for further reading.Are these changes tested?
yes
Are there any user-facing changes?
Yes, since this is an documentation chang