dbx-core 0.2.2

High-performance file-based database engine with 5-Tier Hybrid Storage
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

//! Storage module — 5-Tier Hybrid Storage architecture.
//!
//! All storage engines implement the [`StorageBackend`] trait.
//! The SQL layer depends only on this trait (Dependency Inversion Principle).

pub mod arrow_ipc;
pub mod backup;
pub mod cache;
pub mod columnar;
pub mod columnar_cache;
pub mod columnar_delta;
pub mod compression;
pub mod delta_store;
pub mod encryption;
pub mod erasure_coding;
pub mod gpu;
pub mod index;
pub mod kv_adapter;
pub mod manager;
pub mod memory_wos;
pub mod metadata;
pub mod native_wos;
pub mod parquet_io;
pub mod partition;
pub mod realtime_sync;
pub mod versioned_batch;

use crate::error::DbxResult;
use std::ops::RangeBounds;

/// Core storage interface — all tiers implement this trait.
///
/// # Design Principles
///
/// - **DIP**: SQL layer depends on this trait, never on concrete types.
/// - **Strategy**: New storage tiers are added by implementing this trait.
/// - **Thread Safety**: `Send + Sync` required for concurrent access.
///
/// # Contract
///
/// - `insert`: Upsert semantics — overwrites existing key.
/// - `get`: Returns `None` for non-existent keys, never errors.
/// - `delete`: Returns `true` if key existed, `false` otherwise.
/// - `scan`: Returns key-value pairs in key order within range.
/// - `flush`: Persists buffered data to durable storage.
/// - `count`: Returns the number of keys in a table.
/// - `table_names`: Returns all table names.
pub trait StorageBackend: Send + Sync {
    /// Insert a key-value pair.
    fn insert(&self, table: &str, key: &[u8], value: &[u8]) -> DbxResult<()>;

    /// Insert multiple key-value pairs in a batch (optimized).
    ///
    /// Default implementation calls insert() sequentially.
    /// Implementations should override this for better performance.
    fn insert_batch(&self, table: &str, rows: Vec<(Vec<u8>, Vec<u8>)>) -> DbxResult<()> {
        for (key, value) in rows {
            self.insert(table, &key, &value)?;
        }
        Ok(())
    }

    /// Get a value by key.
    fn get(&self, table: &str, key: &[u8]) -> DbxResult<Option<Vec<u8>>>;

    /// Delete a key-value pair.
    fn delete(&self, table: &str, key: &[u8]) -> DbxResult<bool>;

    /// Scan a range of keys.
    fn scan<R: RangeBounds<Vec<u8>> + Clone>(
        &self,
        table: &str,
        range: R,
    ) -> DbxResult<Vec<(Vec<u8>, Vec<u8>)>>;

    /// Scan a single key-value pair in a range (optimized).
    fn scan_one<R: RangeBounds<Vec<u8>> + Clone>(
        &self,
        table: &str,
        range: R,
    ) -> DbxResult<Option<(Vec<u8>, Vec<u8>)>>;

    /// Flush any buffered data to durable storage.
    fn flush(&self) -> DbxResult<()>;

    /// Return the number of keys in the given table.
    fn count(&self, table: &str) -> DbxResult<usize>;

    /// Return all table names managed by this backend.
    fn table_names(&self) -> DbxResult<Vec<String>>;
}