Skip to content

[hotfix][docs] Fix incorrect HashMapStateBackend recommendations#28094

Open
Dennis-Mircea wants to merge 2 commits intoapache:masterfrom
Dennis-Mircea:hotfix/fix-HashMapStateBackend-recommendations
Open

[hotfix][docs] Fix incorrect HashMapStateBackend recommendations#28094
Dennis-Mircea wants to merge 2 commits intoapache:masterfrom
Dennis-Mircea:hotfix/fix-HashMapStateBackend-recommendations

Conversation

@Dennis-Mircea
Copy link
Copy Markdown

What is the purpose of the change

This pull request fixes incorrect recommendations in the State Backends documentation. The "encouraged for" bullets under the HashMapStateBackend section were copy-pasted from the EmbeddedRocksDBStateBackend section and incorrectly recommended the heap-based backend for "jobs with large state, long windows, large key/value states" and "all high-availability setups", which is the opposite of HashMapStateBackend's actual sweet spot. The fix replaces them with bullets that reflect HashMapStateBackend's real strengths (in-memory access for state that fits on the JVM heap, avoiding (de-)serialization on every state access). Both the English and Chinese versions of the page are updated to stay in sync.

Brief change log

  • Replaced the misleading bullets under "The HashMapStateBackend is encouraged for:" in docs/content/docs/ops/state/state_backends.md.
  • Mirrored the same fix in the Chinese translation at docs/content.zh/docs/ops/state/state_backends.md.

Verifying this change

This change is a trivial documentation fix without any test coverage. It can be verified by rendering the docs locally (docs/build_docs.sh) and inspecting the "The HashMapStateBackend" section on both the English and Chinese pages.

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

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

Generated-by: [Github Copilot]

@flinkbot
Copy link
Copy Markdown
Collaborator

flinkbot commented May 3, 2026

CI report:

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

Comment thread docs/content/docs/ops/state/state_backends.md Outdated
@github-actions github-actions Bot added the community-reviewed PR has been reviewed by the community. label May 4, 2026
@Dennis-Mircea Dennis-Mircea requested a review from spuru9 May 4, 2026 05:37
Copy link
Copy Markdown
Contributor

@spuru9 spuru9 left a comment

Choose a reason for hiding this comment

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

LGTM

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

Labels

community-reviewed PR has been reviewed by the community.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants