docs: document batch partial-failure semantics (#393) - #541
Merged
Conversation
…h budget wording, batchPut retry advice consistency, faq sub-batch count accuracy)
…handling.md (#393) getRegionErrors() is keyed by internal sub-batch indices, not regionIds, so 're-drive only the failing keys/ranges' advice was wrong there too — aligned with the operations.md wording from the review.
s2x
force-pushed
the
fix/393-doc-batch-partial-failure
branch
from
September 9, 2026 19:47
e7b628a to
c8e9d73
Compare
s2x
marked this pull request as ready for review
September 9, 2026 19:47
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
1 participant
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.
Description
Documents the real partial-failure semantics of the batch operations (
batchGet/batchPut/batchDelete) indocs/operations.md, per issue #393 (DOC-27). All claims verified againstsrc/Client/RawKv/RawKvBatch.phpandsrc/Client/Batch/BatchAsyncExecutor.php.Closes #393
Changes
deleteRangewarning's prominence).**Throws:** BatchPartialFailureExceptionlines onbatchGet,batchPut,batchDelete; non-atomic-write notes with idempotency-based retry guidance per operation.BatchAsyncExecutor, errors accumulated, remaining futures cancelled on first wait-phase failure), the exception's accessors with a recovery example, and the caveat thatgetRegionErrors()keys are internal sub-batch indices, not user keys or TiKV region IDs.BatchDeadlineExceededExceptiondocumented (explicit$deadlineMsonly; no shipped client option wires a batch deadline).deleteRangewarning cross-links to the shared semantics; Error Handling section points to the new subsection.[Unreleased] → Documentation; new FAQ entry on the sub-batch-index caveat indocs/helpers/faq.md.Changelog
BatchPartialFailureExceptionrecovery example and sub-batch-index caveat,BatchDeadlineExceededException) indocs/operations.md. ([DOC-27] Document partial-failure semantics for batch operations #393)Code Review