docs: add HNSW replication doc#7219
Open
BorysTheDev wants to merge 1 commit intomainfrom
Open
Conversation
🤖 Augment PR SummarySummary: Adds a design/spec document describing how Dragonfly replicates global HNSW vector indices during full sync. Changes:
🤖 Was this summary useful? React with 👍 or 👎 |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new design/spec document describing how Dragonfly replicates global HNSW vector indices (graph + per-shard key→DocId mappings) via the RDB full-sync stream, including shard-count mismatch handling.
Changes:
- Documented replication data model (
GlobalDocId), wire format (AUX fields + opcodes 222/223), and restore protocol. - Defined shard-local HNSW lifecycle states/invariants relevant to concurrent writes during serialization/restore.
- Specified a remap procedure for differing master/replica shard counts and version gating via
VER6.
2cdd65f to
cbd3f85
Compare
romange
reviewed
Apr 28, 2026
|
|
||
| | State | Initial condition | HNSW mutation behaviour | | ||
| |-------|-------------------|-------------------------| | ||
| | `kProhibit` | Default at index construction. | Buffered. | |
Collaborator
There was a problem hiding this comment.
The explanations here are not clear
romange
reviewed
Apr 28, 2026
Collaborator
romange
left a comment
There was a problem hiding this comment.
i strongly suggest introducing diagrams: either excalidraw or mermaid - see other docs how they do it.
Collaborator
|
LGTM |
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: Adds a design/spec document describing how Dragonfly replicates global HNSW vector indices during full sync.
Changes: