Skip to content

[FLINK-41494][docs] Clarify that table.exec.uid.generation does not apply to PTFs - #30061

Open
linzch3 wants to merge 1 commit into
apache:masterfrom
linzch3:fix-FLINK-41494-ptf-uid-docs
Open

linzch3 wants to merge 1 commit into
apache:masterfrom
linzch3:fix-FLINK-41494-ptf-uid-docs

Conversation

@linzch3

@linzch3 linzch3 commented Nov 21, 2026

Copy link
Copy Markdown

What is the purpose of the change

The docs for table.exec.uid.generation currently read as if this option always controls how streaming transformations get UIDs for state restore. That is not true for Process Table Functions with set or broadcast semantics: their state is restored by the PTF's uid argument (or the function name if the argument is omitted), regardless of this option. This change makes that exception explicit. See FLINK-41494.

Brief change log

  • Clarified in the table.exec.uid.generation option description that it does not apply to PTFs with set or broadcast semantics
  • Regenerated execution_config_configuration.html so the config docs stay in sync

Verifying this change

Please make sure both new and modified tests in this PR follow the conventions for tests defined in our code quality guide.

This change is a trivial rework / code cleanup without any test coverage.

The added wording was checked against the existing PTF uid / state-restore behavior and the current option description in ExecutionConfigOptions.

Does this pull request potentially affect one of the following parts:

  • Dependencies (does it add or upgrade a dependency): no
  • The public API, i.e., is any changed class annotated with @Public(Evolving): yes (docs-only change to a @PublicEvolving option description; no behavioral change)
  • The serializers: no
  • The runtime per-record code paths (performance sensitive): no
  • Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn, ZooKeeper: no
  • The S3 file system connector: no

Documentation

  • Does this pull request introduce a new feature? no
  • If yes, how is the feature documented? not applicable

Was generative AI tooling used to co-author this PR?
  • Yes (please specify the tool below)

Generated-by: Claude Opus 5.5

@flinkbot

flinkbot commented Nov 21, 2026 •

Copy link
Copy Markdown
Collaborator

CI report:

Bot commands The @flinkbot bot supports the following commands:
  • @flinkbot run azure re-run the last Azure build

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants