Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FLINK-28861][table][docs] Update "upgrading" documentation to includ… #20600

Merged
merged 1 commit into from Aug 16, 2022

Conversation

dannycranmer
Copy link
Contributor

…e notice regarding the Table API operator issue

What is the purpose of the change

Update documentation to add a notice regarding the Table API operator issue in FLINK-28861

Brief change log

  • Updated "upgrading" documentation

Verifying this change

  • Visualised locally in IDE

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): no
  • 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

@flinkbot
Copy link
Collaborator

flinkbot commented Aug 16, 2022

CI report:

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

Copy link
Contributor

@twalthr twalthr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating this section @dannycranmer. I tried to make it a bit more precise. The old behavior was not causing issues for every user. As long as the static counter starts at 0 (stable environment), the state can still be restored. This is why the ALWAYS strategy still exists.

@@ -518,7 +518,12 @@ Savepoints are compatible across Flink versions as indicated by the table below:
<td class="text-center"></td>
<td class="text-center"></td>
<td class="text-center">O</td>
<td class="text-left"></td>
<td class="text-left">
Due to FLIP-190, Flink 1.15.0/1.15.1 changed the way UIDs are generated for TableAPI
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can use the release notes that I added in the JIRA issue (slightly adapted):

For Table API: 1.15.0 and 1.15.1 generated non-deterministic UIDs for operators that make it difficult/impossible to restore state or upgrade to next patch version. A new table.exec.uid.generation config option (with correct default behavior) disables setting a UID for new pipelines from non-compiled plans. Existing pipelines can set table.exec.uid.generation=ALWAYS if the 1.15.0/1 behavior was acceptable due to a stable environment.

I tried to be as concise and helpful as possible.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feel free to shorten it if needed for the table.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the suggestion. I have updated it according to your recommendation, with the addition of a link to the Jira. I do not think it needs shortening, it is not tallest cell in the table. We can always shorten it in the future when it is less relevant.

…e notice regarding the Table API operator issue
Copy link
Contributor

@twalthr twalthr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the update @dannycranmer. LGTM.

@dannycranmer dannycranmer merged commit 9791850 into apache:release-1.15 Aug 16, 2022
@dannycranmer dannycranmer deleted the FLINK-28861 branch August 16, 2022 18:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants