User Defined Functions tutorial#55
Merged
tomncooper merged 31 commits intostreamshub:mainfrom Jun 24, 2025
Merged
Conversation
tomncooper
requested changes
Jun 17, 2025
Contributor
There was a problem hiding this comment.
Thanks for the contribution. This is a really comprehensive tutorial and works great for local interactive queries.
However, it would be good to enhance it for more permanent deployments. There is more detail in my comments but in summary:
- Can you add instructions for building a new container image using the Flink SQL runner as a base and layering in the UDF jar. That container can then be used to launch the session cluster without needing to mount the UDF JAR yourself. It also means someone without a copy of your JAR could use the function in the session cluster.
- Can you add a
FlinkDeploymentexample of how to deploy a query using your function which is standalone. - I personally think it would be better to handle the Currency symbols/codes in an Enum class which handles all the mapping logic.
...urrency-converter/src/main/java/com/github/streamshub/flink/functions/CurrencyConverter.java
Outdated
Show resolved
Hide resolved
...urrency-converter/src/main/java/com/github/streamshub/flink/functions/CurrencyConverter.java
Outdated
Show resolved
Hide resolved
Co-authored-by: Thomas Cooper <code@tomcooper.dev> Update docs/user-defined-functions/index.md Co-authored-by: Thomas Cooper <code@tomcooper.dev> Update docs/user-defined-functions/index.md Co-authored-by: Thomas Cooper <code@tomcooper.dev> Apply suggestions from code review Co-authored-by: Thomas Cooper <code@tomcooper.dev>
piotrpdev
force-pushed
the
docs/user-defined-functions-tutorial
branch
from
7082403 to
8f72f9b
Compare
piotrpdev
added a commit
to piotrpdev/flink-sql-examples
that referenced
this pull request
Jun 18, 2025
piotrpdev
force-pushed
the
docs/user-defined-functions-tutorial
branch
from
4a3e190 to
676072c
Compare
tomncooper
reviewed
Jun 19, 2025
Contributor
There was a problem hiding this comment.
LGTM, a few comments, mostly on aligning the package names and versions between the tutorial and example code. I edited my local copy of you branch and verified that everything works as expected.
We also need to decide if we are going to upload the example udf image to the streamshub quay repo so the standalone example will work as is.
tutorials/user-defined-functions/standalone-etl-udf-deployment.yaml
Outdated
Show resolved
Hide resolved
tutorials/user-defined-functions/standalone-etl-udf-deployment.yaml
Outdated
Show resolved
Hide resolved
Co-authored-by: Thomas Cooper <code@tomcooper.dev>
tomncooper
reviewed
Jun 24, 2025
Contributor
tomncooper
left a comment
tomncooper
left a comment
There was a problem hiding this comment.
Great work @piotrpdev! Just a couple of small nits and then I'll approve.
Co-authored-by: Thomas Cooper <code@tomcooper.dev>
tomncooper
approved these changes
Jun 24, 2025
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.
Note
The links to the Interactive ETL example don't work on the website, like the previously mentioned Prometheus links. They do work when reading the Markdown files directly on GitHub.