Expand description
kevy-replicate — primary-to-replica streaming replication.
One primary streams every applied mutation to N read replicas over a long-lived TCP connection, using a RESP3-extended frame format with an offset envelope. New replicas join via an inline snapshot ship, then catch up from the live frame stream.
wire— RESP-based frame format (seedocs/wire.md).wire_snapshot(internal) — snapshot-ship framing for the joining replica.source— primary-side bounded backlog indexed by offset.handshake—REPLICATE FROM <offset> ID <id>parse ++ACKformat.slot— per-replica state + reconnect-window expiry.replica— replica-side blocking TCP client (handshake + frame-decoding iterator).
§Applying replicated frames
ReplicaClient yields decoded (offset, Argv) tuples; applying
them to a local store is the caller’s responsibility — the right
dispatcher depends on where the replica’s data lives. The wire
format intentionally carries the exact RESP argv the primary
applied, so any dispatcher that hands Argv through Redis-verb
routing produces a byte-equivalent local store.
The canonical in-process recipe — drop into a fresh
kevy::KeyspaceStore and dispatch through kevy::KevyCommands:
use kevy_replicate::replica::ReplicaClient;
let mut client = ReplicaClient::connect(("primary:16004"), "replica-a", 0)?;
let kevy = kevy::KevyCommands::new();
let mut store = kevy::KeyspaceStore::new();
for result in &mut client {
let frame = result?;
kevy.dispatch(&mut store, &frame.argv);
}See the replica_apply_dispatch_mirrors_primary_store integration
test in crates/kevy/tests/replication.rs for the pattern under
the full primary+replica end-to-end harness.
The kevy binary also ships full server-as-replica mode (it
auto-spawns a ReplicaClient when [replication] role = "replica",
routing frames into the reactor with re-replication suppression);
the in-process recipe above is for any user that wants to drive
replication themselves.
Modules§
- feed
- CDC feed layer over
crate::source::ReplicationSource— the(generation, offset)cursor semantics the public FEED.* /changes_sincesurfaces speak. - handshake
- Replication handshake — the first round-trip a replica makes against the primary’s replication TCP listener.
- replica
- Replica-side client — connect to a primary’s replication listener, perform the handshake, then yield decoded mutation frames in order.
- slot
- Per-replica slot bookkeeping for the primary’s streaming loop.
- source
- Primary-side replication source — bounded backlog of recent mutations, indexed by monotonic offset.
- wire
- Wire format for replicated mutations — see
docs/wire.mdfor the full spec.