[FLINK-39764] Support dynamic table options in Table API#28266
Open
HundalTaran wants to merge 1 commit into
Open
[FLINK-39764] Support dynamic table options in Table API#28266HundalTaran wants to merge 1 commit into
HundalTaran wants to merge 1 commit into
Conversation
Collaborator
davidradl
reviewed
Jun 4, 2026
| * @param path The path of a table API object to scan. | ||
| * @param dynamicOptions A map of option key-value pairs to override on the table. | ||
| * @return The {@link Table} object describing the pipeline for further transformations. | ||
| * @throws ValidationException if the table is not found, is a view, or dynamic options are |
Contributor
There was a problem hiding this comment.
what about materialized tables?
davidradl
reviewed
Jun 4, 2026
| * @param path The path of a table API object to scan. | ||
| * @param dynamicOptions A map of option key-value pairs to override on the table. | ||
| * @return The {@link Table} object describing the pipeline for further transformations. | ||
| * @throws ValidationException if the table is not found, is a view, or dynamic options are |
Contributor
There was a problem hiding this comment.
what happens if the options specified are not valid - I assume this would be a validation error as well.
davidradl
reviewed
Jun 4, 2026
| * @throws ValidationException if the table is not found, is a view, or dynamic options are | ||
| * disabled. | ||
| */ | ||
| Table from(String path, Map<String, String> dynamicOptions); |
Contributor
There was a problem hiding this comment.
are all dynamic options Strings?
davidradl
reviewed
Jun 4, 2026
| Table from(String path); | ||
|
|
||
| /** | ||
| * Reads a registered table and applies dynamic options, returning the corresponding {@link |
Contributor
There was a problem hiding this comment.
We should update the documentation to describe this and why the user would want to do this with examples.
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
3 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.
What is the purpose of the change
Currently, dynamic table options (e.g., overriding
scan.startup.modeat query time) are only available through the SQL API viaOPTIONShints:sql: SELECT id, name FROM kafka_table1 /*+ OPTIONS('scan.startup.mode'='earliest-offset') */;
Table API users who want to override table options dynamically have no equivalent mechanism. They are forced to drop into
tEnv.executeSql()with raw SQL strings, which negates the purpose of using the type-safe Table API.Brief change log
Add a new overloaded method
from(String path, Map<String, String> dynamicOptions)to theTableEnvironmentinterface. This provides Table API users with the same dynamic option override capability that SQL users have viaOPTIONShints.Verifying this change
Added 6 test methods:
testFromWithDynamicOptions: Verifies dynamic options are merged with existing table optionstestFromWithDynamicOptionsOverridesExisting: Verifies dynamic options override static options on key conflict |testFromWithEmptyDynamicOptions: Verifies empty map is a no-op, original options preserved |testFromWithDynamicOptionsOnViewThrows: VerifiesValidationExceptionwhen applied to a viewtestFromWithDynamicOptionsDisabledThrows: VerifiesValidationExceptionwhen config is disabledtestFromWithDynamicOptionsTableNotFound: VerifiesValidationExceptionfor non-existent tableDoes this pull request potentially affect one of the following parts:
@Public(Evolving): (yes / no) - noDocumentation
Was generative AI tooling used to co-author this PR?
Yes, had taken help from kiro.