docs: Example of calling Python UDF & UDAF in SQL #258
Conversation
This file contains 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
simicd
commented
Mar 4, 2023
| @@ -190,7 +190,7 @@ def udaf(accum, input_type, return_type, state_type, volatility, name=None): | |||
| "`accum` must implement the abstract base class Accumulator" | |||
| ) | |||
| if name is None: | |||
| name = accum.__qualname__ | |||
| name = accum.__qualname__.lower() | |||
There was a problem hiding this comment.
Previously calling the UDAF in SQL would fail if name is not specified (i.e. both MyAccumulator(b) and myaccumulator(b) would fail when running e.g. result_df = ctx.sql(f"select a, myaccumulator(b) as b_aggregated from {table_name}") ). With this change both the uppercase & lowercase variant will work.
simicd
commented
Mar 4, 2023
Comment on lines
+78
to
+82
| # Query the DataFrame using SQL | ||
| table_name = ctx.catalog().database().names().pop() | ||
| result_df = ctx.sql( | ||
| f"select a, my_accumulator(b) as b_aggregated from {table_name} group by a order by a" | ||
| ) |
There was a problem hiding this comment.
Here it would be nice if the table name can be set in the from... context functions so table_name is known, have created ticket #259 as follow-up task
andygrove
approved these changes
Mar 6, 2023
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?
Closes #138
Rationale for this change
Document how to utilize Python UDFs & UDAFs in SQL
What changes are included in this PR?
Document examples & link in README.md
Are there any user-facing changes?
Additional examples/documentation