rustminidb 0.2.0

A lightweight embedded database with native REST API
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
//! 基于 redb 的存储引擎实现
//!
//! redb 是一个纯 Rust 的嵌入式 KV 存储引擎,支持 ACID 事务。
//! 架构:
//! - `__schemas__` 表存储所有表的元数据(TableSchema)
//! - `__data__{table}` 表存储用户数据(主键 → 行)

use std::path::Path;
use std::sync::Arc;

use redb::{Database, ReadableTable, TableDefinition};

use crate::error::{EngineError, Result};
use crate::sql::types::{Row, Value};
use crate::storage::encoding::serialize_value;
use crate::storage::engine::{SharedEngine, StorageEngine};
use crate::storage::schema::TableSchema;

/// 基于 redb 的存储引擎实现
pub struct RedbEngine {
    db: Database,
}

// redb 的表定义
const SCHEMA_TABLE: TableDefinition<&str, &[u8]> = TableDefinition::new("__schemas__");
const DATA_TABLE_PREFIX: &str = "__data__";

impl RedbEngine {
    /// 打开数据库文件,不存在则创建
    pub fn open<P: AsRef<Path>>(path: P) -> Result<Self> {
        let db = Database::create(path)?;
        // 初始化 schema 表
        let write_txn = db.begin_write()?;
        {
            let _ = write_txn.open_table(SCHEMA_TABLE)?;
        }
        write_txn.commit()?;
        Ok(Self { db })
    }

    /// 获取用户数据表的 redb 名称
    fn data_table_name(table: &str) -> String {
        format!("{}{}", DATA_TABLE_PREFIX, table)
    }
}

impl StorageEngine for RedbEngine {
    fn create_table(&self, schema: &TableSchema) -> Result<()> {
        let write_txn = self.db.begin_write()?;

        // 检查表是否已存在
        {
            let schema_table = write_txn.open_table(SCHEMA_TABLE)?;
            if schema_table.get(schema.name.as_str())?.is_some() {
                return Err(EngineError::TableAlreadyExists(schema.name.clone()).into());
            }
        }

        // 保存 schema
        {
            let mut schema_table = write_txn.open_table(SCHEMA_TABLE)?;
            let encoded = bincode::serialize(schema)?;
            schema_table.insert(schema.name.as_str(), encoded.as_slice())?;
        }

        // 创建数据表
        {
            let data_table_name = Self::data_table_name(&schema.name);
            let _ = write_txn.open_table(TableDefinition::<&[u8], &[u8]>::new(&data_table_name))?;
        }

        write_txn.commit()?;
        Ok(())
    }

    fn drop_table(&self, name: &str) -> Result<()> {
        let write_txn = self.db.begin_write()?;

        // 删除 schema
        {
            let mut schema_table = write_txn.open_table(SCHEMA_TABLE)?;
            schema_table.remove(name)?;
        }

        // 删除数据表
        {
            let data_table_name = Self::data_table_name(name);
            // redb 不支持直接删除表,但可以清空
            // 这里我们通过删除 schema 来标记表已删除
            // 数据表在下次 compact 时会被回收
            let mut data_table = write_txn.open_table::<&[u8], &[u8]>(
                TableDefinition::new(&data_table_name),
            )?;
            // 遍历删除所有数据
            let keys: Vec<Vec<u8>> = data_table
                .iter()?
                .map(|item| item.map(|(k, _)| k.value().to_vec()))
                .collect::<std::result::Result<Vec<_>, _>>()?;
            for key in keys {
                data_table.remove(key.as_slice())?;
            }
        }

        write_txn.commit()?;
        Ok(())
    }

    fn get_schema(&self, name: &str) -> Result<Option<TableSchema>> {
        let read_txn = self.db.begin_read()?;
        let schema_table = read_txn.open_table(SCHEMA_TABLE)?;

        match schema_table.get(name)? {
            Some(bytes) => {
                let schema: TableSchema = bincode::deserialize(bytes.value())?;
                Ok(Some(schema))
            }
            None => Ok(None),
        }
    }

    fn list_tables(&self) -> Result<Vec<String>> {
        let read_txn = self.db.begin_read()?;
        let schema_table = read_txn.open_table(SCHEMA_TABLE)?;

        let mut tables = Vec::new();
        for item in schema_table.iter()? {
            let (key, _) = item?;
            tables.push(key.value().to_string());
        }
        Ok(tables)
    }

    fn insert_row(&self, table: &str, row: Row) -> Result<()> {
        let schema = self
            .get_schema(table)?
            .ok_or_else(|| EngineError::TableNotFound(table.to_string()))?;

        // 获取主键值
        let pk_idx = schema
            .pk_index()
            .ok_or_else(|| EngineError::NoPrimaryKey(table.to_string()))?;
        let pk = &row.values[pk_idx];

        // 检查主键是否已存在
        let pk_bytes = serialize_value(pk);
        let read_txn = self.db.begin_read()?;
        let data_table_name = Self::data_table_name(table);
        let data_table = read_txn.open_table(TableDefinition::<&[u8], &[u8]>::new(&data_table_name))?;
        if data_table.get(pk_bytes.as_slice())?.is_some() {
            return Err(EngineError::PrimaryKeyConflict(format!(
                "表 '{}' 中主键 '{:?}' 已存在",
                table, pk
            ))
            .into());
        }
        drop(read_txn);

        // 序列化行数据
        let row_bytes = bincode::serialize(&row)?;

        let write_txn = self.db.begin_write()?;
        {
            let data_table_name = Self::data_table_name(table);
            let mut data_table = write_txn.open_table(TableDefinition::<&[u8], &[u8]>::new(&data_table_name))?;
            data_table.insert(pk_bytes.as_slice(), row_bytes.as_slice())?;
        }
        write_txn.commit()?;
        Ok(())
    }

    fn get_row(&self, table: &str, pk: &Value) -> Result<Option<Row>> {
        let read_txn = self.db.begin_read()?;
        let data_table_name = Self::data_table_name(table);
        let data_table = read_txn.open_table(TableDefinition::<&[u8], &[u8]>::new(&data_table_name))?;

        let pk_bytes = serialize_value(pk);
        match data_table.get(pk_bytes.as_slice())? {
            Some(value_bytes) => {
                let row: Row = bincode::deserialize(value_bytes.value())?;
                Ok(Some(row))
            }
            None => Ok(None),
        }
    }

    fn scan_table(&self, table: &str) -> Result<Vec<Row>> {
        let read_txn = self.db.begin_read()?;
        let data_table_name = Self::data_table_name(table);
        let data_table = read_txn.open_table(TableDefinition::<&[u8], &[u8]>::new(&data_table_name))?;


        let mut rows = Vec::new();
        for item in data_table.iter()? {
            let (_, value) = item?;
            let row: Row = bincode::deserialize(value.value())?;
            rows.push(row);
        }
        Ok(rows)
    }

    fn update_row(&self, table: &str, pk: &Value, row: Row) -> Result<()> {
        let schema = self
            .get_schema(table)?
            .ok_or_else(|| EngineError::TableNotFound(table.to_string()))?;

        // 验证新数据的列数
        if row.values.len() != schema.columns.len() {
            return Err(EngineError::NoPrimaryKey(format!(
                "列数不匹配: 期望 {} 列,实际 {}",
                schema.columns.len(),
                row.values.len()
            ))
            .into());
        }

        let pk_bytes = serialize_value(pk);
        let row_bytes = bincode::serialize(&row)?;

        let write_txn = self.db.begin_write()?;
        {
            let data_table_name = Self::data_table_name(table);
            let mut data_table = write_txn.open_table(TableDefinition::<&[u8], &[u8]>::new(&data_table_name))?;
            // redb 的 insert 会覆盖已有值,等同于 update
            data_table.insert(pk_bytes.as_slice(), row_bytes.as_slice())?;
        }
        write_txn.commit()?;
        Ok(())
    }

    fn delete_row(&self, table: &str, pk: &Value) -> Result<bool> {
        let pk_bytes = serialize_value(pk);
        let write_txn = self.db.begin_write()?;
        let data_table_name = Self::data_table_name(table);
        let mut data_table = write_txn.open_table(TableDefinition::<&[u8], &[u8]>::new(&data_table_name))?;
        let result = data_table.remove(pk_bytes.as_slice())?.is_some();
        drop(data_table);
        write_txn.commit()?;
        Ok(result)
    }

    fn row_count(&self, table: &str) -> Result<u64> {
        let read_txn = self.db.begin_read()?;
        let data_table_name = Self::data_table_name(table);
        let data_table = read_txn.open_table(TableDefinition::<&[u8], &[u8]>::new(&data_table_name))?;
        let mut count = 0u64;
        for _ in data_table.iter()? {
            count += 1;
        }
        Ok(count)
    }

    fn table_exists(&self, name: &str) -> Result<bool> {
        Ok(self.get_schema(name)?.is_some())
    }

    fn update_schema(&self, schema: &TableSchema) -> Result<()> {
        let write_txn = self.db.begin_write()?;
        {
            let mut schema_table = write_txn.open_table(SCHEMA_TABLE)?;
            if schema_table.get(schema.name.as_str())?.is_some() {
                let encoded = bincode::serialize(schema)?;
                schema_table.insert(schema.name.as_str(), encoded.as_slice())?;
            }
        }
        write_txn.commit()?;
        Ok(())
    }
}

/// 创建共享的 RedbEngine 实例
pub fn create_engine<P: AsRef<Path>>(path: P) -> Result<SharedEngine> {
    let engine = RedbEngine::open(path)?;
    Ok(Arc::new(engine))
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::sql::types::{ColumnDef, ColumnType, Value};
    use tempfile::TempDir;

    fn create_test_schema() -> TableSchema {
        TableSchema {
            name: "test".into(),
            columns: vec![
                ColumnDef {
                    name: "id".into(),
                    col_type: ColumnType::Integer,
                    nullable: false,
                    is_primary_key: true,
                    default: None,
                    comment: None,
                },
                ColumnDef {
                    name: "name".into(),
                    col_type: ColumnType::Text,
                    nullable: false,
                    is_primary_key: false,
                    default: None,
                    comment: None,
                },
            ],
            primary_key: vec!["id".into()],
            comment: None,
        }
    }

    #[test]
    fn test_create_table() {
        let dir = TempDir::new().unwrap();
        let engine = RedbEngine::open(dir.path().join("test.db")).unwrap();
        let schema = create_test_schema();
        engine.create_table(&schema).unwrap();

        let loaded = engine.get_schema("test").unwrap().unwrap();
        assert_eq!(loaded.name, "test");
        assert_eq!(loaded.columns.len(), 2);
    }

    #[test]
    fn test_insert_and_get() {
        let dir = TempDir::new().unwrap();
        let engine = RedbEngine::open(dir.path().join("test.db")).unwrap();
        engine.create_table(&create_test_schema()).unwrap();

        engine
            .insert_row(
                "test",
                Row {
                    values: vec![Value::Integer(1), Value::Text("Alice".into())],
                },
            )
            .unwrap();
        engine
            .insert_row(
                "test",
                Row {
                    values: vec![Value::Integer(2), Value::Text("Bob".into())],
                },
            )
            .unwrap();

        let row = engine.get_row("test", &Value::Integer(1)).unwrap().unwrap();
        assert_eq!(row.values[1], Value::Text("Alice".into()));

        let rows = engine.scan_table("test").unwrap();
        assert_eq!(rows.len(), 2);
    }

    #[test]
    fn test_update_and_delete() {
        let dir = TempDir::new().unwrap();
        let engine = RedbEngine::open(dir.path().join("test.db")).unwrap();
        engine.create_table(&create_test_schema()).unwrap();

        engine
            .insert_row(
                "test",
                Row {
                    values: vec![Value::Integer(1), Value::Text("Alice".into())],
                },
            )
            .unwrap();

        engine
            .update_row(
                "test",
                &Value::Integer(1),
                Row {
                    values: vec![Value::Integer(1), Value::Text("Updated".into())],
                },
            )
            .unwrap();

        let row = engine.get_row("test", &Value::Integer(1)).unwrap().unwrap();
        assert_eq!(row.values[1], Value::Text("Updated".into()));

        let deleted = engine.delete_row("test", &Value::Integer(1)).unwrap();
        assert!(deleted);
        assert!(engine.get_row("test", &Value::Integer(1)).unwrap().is_none());
    }

    #[test]
    fn test_primary_key_conflict() {
        let dir = TempDir::new().unwrap();
        let engine = RedbEngine::open(dir.path().join("test.db")).unwrap();
        engine.create_table(&create_test_schema()).unwrap();

        engine
            .insert_row(
                "test",
                Row {
                    values: vec![Value::Integer(1), Value::Text("Alice".into())],
                },
            )
            .unwrap();

        let result = engine.insert_row(
            "test",
            Row {
                values: vec![Value::Integer(1), Value::Text("Bob".into())],
            },
        );
        assert!(result.is_err());
    }

    #[test]
    fn test_list_tables() {
        let dir = TempDir::new().unwrap();
        let engine = RedbEngine::open(dir.path().join("test.db")).unwrap();
        engine.create_table(&create_test_schema()).unwrap();

        let tables = engine.list_tables().unwrap();
        assert!(tables.contains(&"test".to_string()));
    }
}