thunderdb/
lib.rs

1//! Summary: thunder - A minimal, embedded, transactional key-value database engine.
2//! Copyright (c) YOAB. All rights reserved.
3
4pub mod aligned;
5pub mod arena;
6pub mod bloom;
7pub mod btree;
8pub mod bucket;
9pub mod checkpoint;
10pub mod coalescer;
11pub mod concurrent;
12pub mod db;
13pub mod error;
14#[cfg(feature = "failpoint")]
15pub mod failpoint;
16pub mod freelist;
17pub mod group_commit;
18pub mod io_backend;
19pub mod iter;
20pub mod ivec;
21pub mod meta;
22pub mod mmap;
23pub mod node_pool;
24pub mod overflow;
25pub mod page;
26pub mod parallel;
27pub mod snapshot;
28pub mod tx;
29pub mod value;
30pub mod wal;
31pub mod wal_record;
32
33// io_uring backend (Linux only, feature-gated)
34#[cfg(all(target_os = "linux", feature = "io_uring"))]
35pub mod uring;
36
37// Re-export public API at crate root for convenience.
38pub use aligned::{AlignedBuffer, AlignedBufferPool, DEFAULT_ALIGNMENT};
39pub use arena::{Arena, DEFAULT_ARENA_SIZE, TypedArena};
40pub use btree::{BTreeIter, BTreeRangeIter, Bound};
41pub use bucket::{
42    BucketBound, BucketIter, BucketMut, BucketRangeIter, BucketRef, MAX_BUCKET_NAME_LEN,
43    MAX_NESTING_DEPTH, NestedBucketIter, NestedBucketRef,
44};
45pub use checkpoint::{CheckpointConfig, CheckpointInfo, CheckpointManager};
46pub use concurrent::{PARALLEL_THRESHOLD, ParallelWriteStats, prepare_entries_parallel};
47pub use db::{Database, DatabaseOptions};
48pub use error::{Error, Result};
49pub use group_commit::{GroupCommitConfig, GroupCommitManager};
50pub use io_backend::{IoBackend, ReadOp, ReadResult, SyncBackend, WriteOp};
51pub use iter::{IterOptions, MetricsIter, PrefetchIter, ScanMetrics};
52pub use mmap::{AccessPattern, Mmap, MmapOptions};
53pub use node_pool::{DEFAULT_MAX_POOLED, NodePool, PoolStats, PooledBranchNode, PooledLeafNode};
54pub use overflow::{DEFAULT_OVERFLOW_THRESHOLD, OverflowRef};
55pub use page::PageSizeConfig;
56pub use parallel::{ParallelConfig, ParallelWriter, partition_for_parallel};
57pub use snapshot::{Snapshot, SnapshotId, SnapshotManager, SnapshotStats};
58pub use tx::{ReadTx, WriteTx};
59pub use value::{BorrowedValue, MaybeOwnedValue, OwnedValue};
60pub use wal::{Lsn, SyncPolicy, Wal, WalConfig};
61pub use wal_record::{RECORD_HEADER_SIZE, WalRecord};
62
63#[cfg(all(target_os = "linux", feature = "io_uring"))]
64pub use uring::UringBackend;
65
66#[cfg(feature = "failpoint")]
67pub use failpoint::{
68    FailAction, FailpointBuilder, FailpointGuard, FailpointRegistry, FailpointScopeGuard,
69    RandomFailpointSelector,
70};
thunderdb/lib.rs

thunderdb/
lib.rs
