- BARADB_RAFT_CLIENT_PEERS maps node id → SQL client host:port - Followers proxy DML/DDL to the known leader over the wire protocol (falls back to "not leader" when the map is missing) - E2E: follower CREATE/INSERT succeed via forward; docs updated
3.9 KiB
Distributed Systems
BaraDB supports distributed deployment with Raft consensus, sharding, and replication.
⚠️ Multi-Database Limitation The distributed modules (Raft, sharding, and replication) are currently wired to the
defaultdatabase only. If you use multiple databases (CREATE DATABASE,USE DATABASE), distributed features do not yet span across them. Each database would need its own cluster setup.
Raft Consensus
Leader election and log replication over TCP. Enable with:
| Env | Meaning |
|---|---|
BARADB_RAFT_ENABLED=true |
Turn on Raft |
BARADB_RAFT_NODE_ID |
This node's id |
BARADB_RAFT_PORT |
Raft TCP port |
BARADB_RAFT_PEERS |
Comma-separated id@host:port (include self) |
BARADB_RAFT_WRITE_TIMEOUT_MS |
Max wait for majority commit on SQL writes (default 5000) |
BARADB_RAFT_CLIENT_PEERS |
Optional id@host:clientPort map for leader write forwarding |
When Raft is enabled, SQL DML (INSERT/UPDATE/DELETE/MERGE and transactional COMMIT) and schema DDL (CREATE/DROP/ALTER table, index, view, graph, …) are accepted only on the leader of the default database. DML ships as put/delete log entries; DDL ships as a ddl entry with the original SQL and is re-executed on every node at apply. Followers that receive a write/DDL forward it to the leader when BARADB_RAFT_CLIENT_PEERS maps the leader id to a SQL client address; otherwise they return not leader; leader is '…'. Writes against any other database name are rejected (raft writes only supported on the 'default' database). CREATE/DROP DATABASE are not raft-replicated (multi-DB is out of scope for v1). Committed DML also updates secondary B-tree/FTS/HNSW indexes and in-memory graphs.
import barabadb/core/raft
var cluster = newRaftCluster()
cluster.addNode("node1")
cluster.addNode("node2")
cluster.addNode("node3")
let n1 = cluster.nodes["n1"]
n1.becomeCandidate()
n1.becomeLeader()
let entry = n1.appendLog("SET key1 value1")
Sharding
Distribute data across nodes:
import barabadb/core/sharding
var router = newShardRouter(ShardConfig(
numShards: 4,
replicas: 2,
strategy: ssHash
))
router.rebalance(@["node1", "node2", "node3"])
let shard = router.getShard("user_123")
Sharding Strategies
| Strategy | Description |
|---|---|
ssHash |
Hash-based sharding |
ssRange |
Range-based sharding |
ssConsistent |
Consistent hashing |
Replication
import barabadb/core/replication
var rm = newReplicationManager(rmSync)
rm.addReplica(newReplica("r1", "10.0.0.1", 9472))
rm.connectReplica("r1")
let lsn = rm.writeLsn(@[1'u8, 2, 3])
rm.ackLsn("r1", lsn)
Replication Modes
| Mode | Description |
|---|---|
rmSync |
Synchronous replication |
rmAsync |
Asynchronous replication |
rmSemiSync |
Semi-synchronous replication |
Gossip Protocol
Membership and failure detection:
import barabadb/core/gossip
var g = newGossipManager()
g.addNode("node1")
g.addNode("node2")
g.tick() # Exchange membership info
Distributed Transactions
Two-phase commit across nodes:
import barabadb/core/disttxn
var dt = newDistributedTxn()
dt.prepare(@["node1", "node2"])
dt.commit()
Formal Verification
Core distributed algorithms are formally specified in TLA+ and model-checked:
- Raft Consensus —
formal-verification/raft.tla- Verified: ElectionSafety, StateMachineSafety
- Two-Phase Commit —
formal-verification/twopc.tla- Verified: Atomicity, NoOrphanBlocks
- Replication —
formal-verification/replication.tla- Verified: MonotonicLsn, AcksRemovePending
Run TLC locally:
cd formal-verification
java -cp tla2tools.jar tlc2.TLC -config models/raft.cfg raft.tla
java -cp tla2tools.jar tlc2.TLC -config models/twopc.cfg twopc.tla
java -cp tla2tools.jar tlc2.TLC -config models/replication.cfg replication.tla