txn-db 0.3.0

MVCC transaction engine for Rust storage layers. Snapshot isolation and serializable transactions with multi-version concurrency control, conflict detection, and a durable transaction log on wal-db. The transaction layer for embedded databases and Hive DB.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

//! Many threads increment one shared counter through the database. Each
//! increment is a read-modify-write transaction that retries when it loses a
//! commit race, so no update is ever lost: the final value equals the exact
//! number of increments issued.
//!
//! Run with: `cargo run --example concurrent_counter`

use std::sync::Arc;
use std::thread;

use txn_db::{Db, TxnError};

const THREADS: u64 = 8;
const PER_THREAD: u64 = 1_000;

fn main() -> Result<(), TxnError> {
    let db = Db::new();

    // Initialise the counter to zero.
    let mut tx = db.begin();
    tx.put(b"counter".to_vec(), 0u64.to_le_bytes().to_vec());
    tx.commit()?;

    // Spawn workers; each clones the cheap database handle.
    let handles: Vec<_> = (0..THREADS)
        .map(|_| {
            let db = db.clone();
            thread::spawn(move || increment_many(&db, PER_THREAD))
        })
        .collect();

    let mut total_retries = 0u64;
    for handle in handles {
        total_retries += handle.join().expect("worker thread panicked");
    }

    let final_value = read_u64(&db.snapshot().get(b"counter")?.expect("counter exists"));
    println!("final counter: {final_value}");
    println!("expected:      {}", THREADS * PER_THREAD);
    println!("commit retries caused by contention: {total_retries}");
    assert_eq!(final_value, THREADS * PER_THREAD);

    Ok(())
}

/// Increment the counter `count` times; return how many commits had to retry.
fn increment_many(db: &Db, count: u64) -> u64 {
    let mut retries = 0;
    for _ in 0..count {
        loop {
            let mut tx = db.begin();
            let current = tx
                .get(b"counter")
                .expect("read")
                .map_or(0, |b| read_u64(&b));
            tx.put(b"counter".to_vec(), (current + 1).to_le_bytes().to_vec());
            match tx.commit() {
                Ok(_) => break,
                Err(e) if e.is_retryable() => {
                    retries += 1;
                    continue;
                }
                Err(e) => panic!("unexpected error: {e}"),
            }
        }
    }
    retries
}

fn read_u64(bytes: &Arc<[u8]>) -> u64 {
    let mut buf = [0u8; 8];
    buf.copy_from_slice(&bytes[..8]);
    u64::from_le_bytes(buf)
}