docs: add Chunk Scanning documentation to fault-tolerant step section#5422
Open
won-seoop wants to merge 1 commit into
Open
docs: add Chunk Scanning documentation to fault-tolerant step section#5422won-seoop wants to merge 1 commit into
won-seoop wants to merge 1 commit into
Conversation
spring-projectsGH-3946: The configuring-skip and retry-logic sections did not document chunk scanning, which is the mechanism Spring Batch uses to identify failing items when a write exception occurs in a fault-tolerant step. This led to users being surprised that items are re-processed even when NeverRetryPolicy is configured. Added a new chunk-scanning.adoc page covering: - How chunk scanning works (rollback → one-by-one scan → skip/fail) - Why it is triggered regardless of retry policy - Impact on the ItemProcessor and how processorNonTransactional() helps - Relationship between chunk scanning, skip, and retry Also added: - Entry in nav.adoc after retry-logic.adoc - NOTE cross-reference in configuring-skip.adoc Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.
Summary
Closes #3946
The existing fault-tolerant step documentation (configuring-skip and retry-logic) did not explain chunk scanning, which is the mechanism Spring Batch uses to identify which individual item caused a write failure. This caused confusion: users who set
NeverRetryPolicyexpected no re-processing to occur, but were surprised when Spring Batch still re-invoked their processor multiple times per chunk.Changes
Added a new
chunk-scanning.adocpage (linked in nav afterretry-logic.adoc) covering:NeverRetryPolicy)processorNonTransactional()to avoid this (with Java and XML examples)Also added:
nav.adocafterretry-logic.adocconfiguring-skip.adocpointing to the new pageTest plan