Repository navigation
docs: document ingest() and the SST bulk-import import-mode hazard (#390) - #530
Merged
Merged
Conversation
s2x
force-pushed
the
fix/390-doc-ingest-sst-hazard
branch
from
September 9, 2026 18:22
a3d665b to
475e1f6
Compare
s2x
force-pushed
the
fix/390-doc-ingest-sst-hazard
branch
from
September 9, 2026 18:43
a7cec7c to
6521075
Compare
s2x
marked this pull request as ready for review
September 9, 2026 18:43
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.
Description
Documents
RawKvClient::ingest()(SST bulk import) and its cluster-wide import-mode operational hazard, per issue #390 [DOC-24]. Everything is verified againstsrc/Client/RawKv/SstIngestor.php,RawKvClient::ingest()andConnectionFactory::buildTimeoutConfig().Closes #390
Changes
docs/operations.md: new "Bulk Import (SST Ingest)" section (TOC item 8) — signature, semantics (client-sideksort, per-region grouping, ImportSSTRawWritestreaming with 1024-pair chunks +IngestRPC, TTL only when positive, key validation, no automatic retries), a prominent cluster-wide import-mode warning with the process-death hazard, a concrete recovery procedure, and operational notes (fixed 60 s ingest deadline not settable viacreate(), silently dropped unresolvable keys,maxConcurrencycap).README.md: short "Bulk Import (SST Ingest)" section with the hazard warning and link to the operations guide.docs/troubleshooting.md: new "Cluster Stuck in Import Mode" entry under Performance Issues (symptom / diagnosis / recovery / prevention).CHANGELOG.md: [Unreleased] → Added, [DOC-24] entry ([DOC-24] Documentingest()and the SST bulk-import operational hazard #390).docs/helpers/faq.md: new entry on the silent key-drop ingroupPairsByRegion()and the no-retry / stuck-import-mode pitfalls.Changelog
ingest()(SST bulk import) documented indocs/operations.md,README.mdanddocs/troubleshooting.md, with the import-mode cluster-wide hazard, recovery procedure and the fixed 60 s ingest deadline. ([DOC-24] Documentingest()and the SST bulk-import operational hazard #390)Code Review