docs: Improve documentation for FunctionFactory / CREATE FUNCTION #17859
+57
−11
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
logical-expr
alamb
changed the title
martin-g
reviewed
Oct 1, 2025
github-actions
bot
removed
the
documentation
|
@milenkovicm since you added this feature initially as I recall, I wonder if you could review this documentation improvement PR? |
milenkovicm
approved these changes
Oct 1, 2025
| /// and interact with [SessionState] to registers new udf, udaf or udwf. | ||
| /// Interface for handling `CREATE FUNCTION` statements and interacting with | ||
| /// [SessionState] to create and register functions ([`ScalarUDF`], | ||
| /// [`AggregateUDF`], [`WindowUDF`], and [`TableFunctionImpl`]) dynamically. |
There was a problem hiding this comment.
I have tried ScalarUDF, and AggregateUDF but never WindowUDF nor TableFunction, I guess users can plug-in whatever they want here
|
A shameless plug 😃 🔌 I have a few more working examples if they are going to help with the evaluation of functionality in InfluxData. |
milenkovicm
reviewed
Oct 1, 2025
| /// ```sql | ||
| /// CREATE FUNCTION f1(BIGINT) | ||
| /// RETURNS BIGINT | ||
| /// RETURN $1 + 1; |
There was a problem hiding this comment.
one note, not related to this PR, it would be great if we could use variable names instead of $1 and support default values, last time i've tried it did not work
CREATE FUNCTION our_add(A BIGINT DEFAULT 3, B BIGINT DEFAULT 1)
RETURNS BIGINT
RETURN $A - $BThere was a problem hiding this comment.
milenkovicm
reviewed
Oct 2, 2025
Co-authored-by: Marko Milenković <milenkovicm@users.noreply.github.com>
|
I've merged this, thanks @alamb, great improvement |
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
Internlly at InfluxData, we are evaluating using
CREATE FUNCTIONbut when I was providing links to the docs, it was a little sparse and unclear what was supported.I think some documentation would make this functionality a little easier to find and use.
What changes are included in this PR?
Add some documentation and links
Are these changes tested?
By CI and I rendered them locally:
Are there any user-facing changes?
I also added
DebugandClonetoRegisterFunctionfor consistency