[FLINK-37586][udf] Add support for options in user-defined functions and update related documentation#4252
Open
Hisoka-X wants to merge 2 commits intoapache:masterfrom
Open
[FLINK-37586][udf] Add support for options in user-defined functions and update related documentation#4252Hisoka-X wants to merge 2 commits intoapache:masterfrom
Hisoka-X wants to merge 2 commits intoapache:masterfrom
Conversation
…and update related documentation
github-actions
bot
added
docs
Member
Author
|
cc @yuxiqian |
yuxiqian
reviewed
Feb 26, 2026
| user-defined-function: | ||
| - name: query_redis | ||
| classpath: com.example.flink.cdc.udf.RedisQueryFunction | ||
| options: |
Member
There was a problem hiding this comment.
nit: Would you prefer putting extra options at the same level as name and classpath? Just like source and pipeline.model:
source:
name: MySQL Source
type: mysql
username: ... # other options
pipeline:
model:
- model-name: CHAT
class-name: OpenAIChatModel
openai.model: ... # other options
Member
Author
There was a problem hiding this comment.
No, this way hard to identifier which option come from flink-cdc, which come from user function.
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
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.
This close https://issues.apache.org/jira/browse/FLINK-37586
This pull request adds support for passing configuration options to user-defined functions (UDFs) in pipeline definitions. It updates both the YAML schema and the internal Java representations to allow specifying an
optionsblock for each UDF, making these options available at runtime. The documentation is updated to explain how to use this feature, and new tests are added to ensure correct parsing and handling.