[Flink 39717][docs] Document SET/RESET key handling for ALTER TABLE, CATALOG, MODEL and DATABASE#28211
Open
raminqaf wants to merge 4 commits into
Open
[Flink 39717][docs] Document SET/RESET key handling for ALTER TABLE, CATALOG, MODEL and DATABASE#28211raminqaf wants to merge 4 commits into
raminqaf wants to merge 4 commits into
Conversation
Spell out the behavior for duplicate keys (last value wins for SET, de-duplicated for RESET), unknown keys (silently ignored on RESET), the empty list (accepted as no-op for SET, rejected for RESET), and the reserved `connector` key (rejected for RESET). Add examples.
Spell out the behavior for duplicate keys (last value wins for SET, de-duplicated for RESET), unknown keys (silently ignored on RESET), the empty list (accepted as no-op for SET, rejected for RESET), and the reserved `type` key (rejected for RESET). Add examples.
Spell out the behavior for duplicate keys (last value wins for SET, de-duplicated for RESET), unknown keys (silently ignored on RESET), and the empty list (rejected for both SET and RESET, unlike ALTER TABLE/CATALOG SET which accept empty as a no-op). Add examples.
Spell out the behavior for duplicate keys (last value wins, warning logged) and the empty list (accepted as no-op). Add an example. ALTER DATABASE only supports SET; there is no RESET form.
Collaborator
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
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
The reference docs for
ALTER TABLE,ALTER CATALOG,ALTER MODEL, andALTER DATABASEdescribeSET/RESETonly as "override the old value with the new one". The actual converter behavior handles several edge cases (duplicate keys, unknown keys, empty lists, reserved keys) that are not documented and differ across the four DDLs. This PR documents that behavior so users can predict the outcome without reading the converter source.Docs-only change. No code changes. Aligns with the per-DDL behavior already documented for
ALTER MATERIALIZED TABLEin FLINK-39662 / FLINK-39663.Brief change log
docs/content/docs/sql/reference/ddl/alter.md: spell out behavior forALTER TABLE,ALTER CATALOG,ALTER MODEL,ALTER DATABASEunderSETandRESET.docs/content.zh/docs/sql/reference/ddl/alter.md: mirror in the Chinese docs.Summary
connectortypeVerifying this change
Docs-only update. No tests added. Documented behavior is covered by existing parser/converter tests for each DDL.
Does this pull request potentially affect one of the following parts:
@Public(Evolving): noDocumentation
Was generative AI tooling used to co-author this PR?
Opus: 4.7