[hotfix][docs] Fix incorrect HashMapStateBackend recommendations#28094
Open
Dennis-Mircea wants to merge 2 commits intoapache:masterfrom
Open
[hotfix][docs] Fix incorrect HashMapStateBackend recommendations#28094Dennis-Mircea wants to merge 2 commits intoapache:masterfrom
Dennis-Mircea wants to merge 2 commits intoapache:masterfrom
Conversation
Collaborator
spuru9
reviewed
May 3, 2026
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
This pull request fixes incorrect recommendations in the State Backends documentation. The "encouraged for" bullets under the
HashMapStateBackendsection were copy-pasted from theEmbeddedRocksDBStateBackendsection 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
docs/content/docs/ops/state/state_backends.md.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:
@Public(Evolving): noDocumentation
Was generative AI tooling used to co-author this PR?
Generated-by: [Github Copilot]