Repository navigation
docs: document the atomic-mode side effects on non-CAS writes (#399) - #762
Merged
s2x merged 5 commits intoOct 24, 2026
Merged
Conversation
…33-document-the-atomic-mode-side-eff # Conflicts: # CHANGELOG.md # docs/helpers/decisions.md
…33-document-the-atomic-mode-side-eff # Conflicts: # CHANGELOG.md # docs/helpers/decisions.md
s2x
deleted the
docs/issue-399-doc-33-document-the-atomic-mode-side-eff
branch
October 24, 2026 19:39
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
Closes #399
The docs did not say that
setAtomicForCAS(true)changes the write path of every put and delete of the client instance, and they gave no guidance for mixed writers.Changes
README.md: scope of the flag —put(),delete(),batchPut(),batchDelete()sendfor_cas;compareAndSwap()andputIfAbsent()require the flag;deleteRange(),deletePrefix()andingest()do not send it.docs/operations.md: Atomic Mode scope list, "Mixed writers" paragraph with the reason (TiKV latches atomic writes and CAS, a plain write takes no latch, so it can land between the CAS read and write), CAS prerequisite note.docs/helpers/decisions.md: entry with the TiKV source references (src/server/service/kv.rs,src/storage/mod.rs,src/storage/txn/commands/).CHANGELOG.md: entry under[Unreleased]/### Fixed.Testing
Documentation only. The client claims were checked in
src/Client/RawKv; the TiKV claims were checked intikv/tikvmaster by the coder and the reviewer.Code Review