sql5 3.6.0

SQLite compatible database with CJK FTS5 full-text search
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
417
418
419
420
421
422
423
424
425
426
427
//! B+Tree 實作
//!
//! B+Tree 是一種自平衡的樹狀資料結構,專為區塊儲存設計。
//! 所有資料儲存在葉節點,內部節點只儲存索引鍵。

use super::node::{Key, Node, Record};
use crate::pager::storage::Storage;

// ============================================================================
// B+Tree 主結構
// ============================================================================

/// B+Tree 索引結構
///
/// # 結構說明
/// - `order`:每個內部節點最多有 order 個子指標
/// - `root`:根頁面的 ID
/// - `size`:樹中記錄的總數
///
/// # B+Tree 特性
/// - 所有資料存在葉節點
/// - 葉節點雙向鏈結
/// - 查詢時間複雜度 O(log n)
pub struct BPlusTree<S: Storage> {
    /// B+Tree 的 order(每節點最大子節點數)
    order: usize,
    /// 儲存後端
    storage: S,
    /// 根頁面 ID
    root: usize,
    /// 樹中鍵值對數量
    size: usize,
}

impl<S: Storage> BPlusTree<S> {
    /// 建立新的 B+Tree
    ///
    /// 會分配根頁面並初始化為空的葉節點
    pub fn new(order: usize, mut storage: S) -> Self {
        assert!(order >= 3, "B+Tree order must be >= 3");
        // 分配並寫入根節點(空葉節點)
        let root_id = storage.alloc_page();
        storage.write_node(root_id, &Node::new_leaf());
        BPlusTree { order, storage, root: root_id, size: 0 }
    }

    /// 開啟已存在的 B+Tree
    pub fn open(order: usize, storage: S, root: usize, size: usize) -> Self {
        BPlusTree { order, storage, root, size }
    }

    /// 插入鍵值對
    ///
    /// 若節點已滿,會觸發分裂並返回分裂資訊
    pub fn insert(&mut self, key: Key, value: Vec<u8>) {
        let record = Record { key, value };
        if let Some(split) = self.insert_recursive(self.root, record) {
            // 根節點分裂,建立新根
            let mut new_root = Node::new_internal();
            new_root.keys.push(split.0);        // 中間鍵提升
            new_root.children.push(self.root);  // 左子樹
            new_root.children.push(split.1);     // 右子樹
            let new_root_id = self.storage.alloc_page();
            self.storage.write_node(new_root_id, &new_root);
            self.root = new_root_id;             // 更新根指標
        }
        self.size += 1;
    }

    /// 精確查詢
    ///
    /// 沿路徑找到葉節點,然後線性搜尋
    pub fn search(&mut self, key: &Key) -> Option<Vec<u8>> {
        let leaf_id = self.find_leaf(self.root, key);
        let leaf = self.storage.read_node(leaf_id);
        // 在葉節點中尋找匹配的記錄
        leaf.records.into_iter().find(|r| &r.key == key).map(|r| r.value)
    }

    /// 範圍查詢 [start, end]
    ///
    /// 找到起始葉節點,沿鏈結走訪直到超過 end
    pub fn range_search(&mut self, start: &Key, end: &Key) -> Vec<Record> {
        let mut results = Vec::new();
        let mut idx = self.find_leaf(self.root, start);
        loop {
            let leaf = self.storage.read_node(idx);
            let next = leaf.next_leaf;  // 下一個葉節點
            let mut done = false;
            for record in leaf.records {
                if &record.key >= start && &record.key <= end {
                    results.push(record);
                } else if &record.key > end {
                    done = true; break;  // 已超出範圍
                }
            }
            if done { break; }
            // 移動到下一個葉節點
            match next { Some(n) => idx = n, None => break }
        }
        results
    }

    /// 刪除鍵值對
    ///
    /// 刪除後若根節點變空且非葉節點,則用其第一個子節點替換根
    pub fn delete(&mut self, key: &Key) -> bool {
        let removed = self.delete_recursive(self.root, key);
        if removed {
            self.size -= 1;
            // 檢查是否需要降低樹高
            let root_node = self.storage.read_node(self.root);
            if !root_node.is_leaf() && root_node.keys.is_empty() {
                self.root = root_node.children[0];
            }
        }
        removed
    }

    /// 返回鍵值對數量
    pub fn len(&self) -> usize { self.size }
    pub fn is_empty(&self) -> bool { self.size == 0 }
    pub fn root_page(&self) -> usize { self.root }
    pub fn flush(&mut self) { self.storage.flush(); }

    /// 全表掃描(按鍵排序)
    pub fn scan_all(&mut self) -> Vec<Record> {
        if self.size == 0 { return Vec::new(); }
        let mut results = Vec::with_capacity(self.size);
        let mut idx = self.first_leaf();
        loop {
            let leaf = self.storage.read_node(idx);
            for record in leaf.records {
                results.push(record);
            }
            match leaf.next_leaf {
                Some(n) => idx = n,
                None => break,
            }
        }
        results
    }

    fn first_leaf(&mut self) -> usize {
        let mut idx = self.root;
        loop {
            let node = self.storage.read_node(idx);
            if node.is_leaf() { return idx; }
            idx = node.children[0];
        }
    }

    fn alloc_node(&mut self, node: Node) -> usize {
        let id = self.storage.alloc_page();
        self.storage.write_node(id, &node);
        id
    }

    fn find_leaf(&mut self, mut idx: usize, key: &Key) -> usize {
        loop {
            let node = self.storage.read_node(idx);
            if node.is_leaf() { return idx; }
            let pos = node.keys.partition_point(|k| k <= key);
            idx = node.children[pos];
        }
    }

    fn insert_recursive(&mut self, idx: usize, record: Record) -> Option<(Key, usize)> {
        let node = self.storage.read_node(idx);
        if node.is_leaf() {
            return self.insert_into_leaf(idx, node, record);
        }
        let pos = node.keys.partition_point(|k| k <= &record.key);
        let child_idx = node.children[pos];
        if let Some((mid_key, new_child)) = self.insert_recursive(child_idx, record) {
            let mut node = self.storage.read_node(idx);
            node.keys.insert(pos, mid_key);
            node.children.insert(pos + 1, new_child);
            let full = node.is_full(self.order);
            self.storage.write_node(idx, &node);
            if full { return Some(self.split_internal(idx)); }
        }
        None
    }

    fn insert_into_leaf(&mut self, idx: usize, mut leaf: Node, record: Record) -> Option<(Key, usize)> {
        let pos = leaf.keys.partition_point(|k| k < &record.key);
        if pos < leaf.keys.len() && leaf.keys[pos] == record.key {
            leaf.records[pos] = record;
            self.storage.write_node(idx, &leaf);
            self.size = self.size.saturating_sub(1);
            return None;
        }
        leaf.keys.insert(pos, record.key.clone());
        leaf.records.insert(pos, record);
        let full = leaf.is_full(self.order);
        self.storage.write_node(idx, &leaf);
        if full { return Some(self.split_leaf(idx)); }
        None
    }

    fn split_leaf(&mut self, idx: usize) -> (Key, usize) {
        let mut left = self.storage.read_node(idx);
        let mid = left.keys.len() / 2;
        let right_keys = left.keys.split_off(mid);
        let right_records = left.records.split_off(mid);
        let old_next = left.next_leaf;
        let promote_key = right_keys[0].clone();
        let mut right = Node::new_leaf();
        right.keys = right_keys;
        right.records = right_records;
        let right_id = self.storage.alloc_page();
        right.next_leaf = old_next;
        left.next_leaf = Some(right_id);
        self.storage.write_node(idx, &left);
        self.storage.write_node(right_id, &right);
        (promote_key, right_id)
    }

    fn split_internal(&mut self, idx: usize) -> (Key, usize) {
        let mut left = self.storage.read_node(idx);
        let mid = left.keys.len() / 2;
        let promote_key = left.keys.remove(mid);
        let right_keys = left.keys.split_off(mid);
        let right_children = left.children.split_off(mid + 1);
        let mut right = Node::new_internal();
        right.keys = right_keys;
        right.children = right_children;
        let right_id = self.storage.alloc_page();
        self.storage.write_node(idx, &left);
        self.storage.write_node(right_id, &right);
        (promote_key, right_id)
    }

    fn delete_recursive(&mut self, idx: usize, key: &Key) -> bool {
        let node = self.storage.read_node(idx);
        if node.is_leaf() { return self.delete_from_leaf(idx, node, key); }
        let pos = node.keys.partition_point(|k| k <= key);
        let child_idx = node.children[pos];
        if !self.delete_recursive(child_idx, key) { return false; }
        let min_keys = (self.order - 1) / 2;
        let child = self.storage.read_node(child_idx);
        if child.keys.len() < min_keys { self.rebalance(idx, pos); }
        true
    }

    fn delete_from_leaf(&mut self, idx: usize, mut leaf: Node, key: &Key) -> bool {
        if let Some(pos) = leaf.keys.iter().position(|k| k == key) {
            leaf.keys.remove(pos);
            leaf.records.remove(pos);
            self.storage.write_node(idx, &leaf);
            true
        } else { false }
    }

    fn rebalance(&mut self, parent: usize, pos: usize) {
        let parent_node = self.storage.read_node(parent);
        let n_children = parent_node.children.len();
        let min_keys = (self.order - 1) / 2;
        if pos + 1 < n_children {
            let right_sib = parent_node.children[pos + 1];
            if self.storage.read_node(right_sib).keys.len() > min_keys {
                self.borrow_from_right(parent, pos); return;
            }
        }
        if pos > 0 {
            let left_sib = parent_node.children[pos - 1];
            if self.storage.read_node(left_sib).keys.len() > min_keys {
                self.borrow_from_left(parent, pos); return;
            }
        }
        if pos + 1 < n_children { self.merge(parent, pos); }
        else { self.merge(parent, pos - 1); }
    }

    fn borrow_from_right(&mut self, parent: usize, pos: usize) {
        let mut pn = self.storage.read_node(parent);
        let cid = pn.children[pos];
        let rid = pn.children[pos + 1];
        let mut child = self.storage.read_node(cid);
        let mut right = self.storage.read_node(rid);
        if child.is_leaf() {
            let bk = right.keys.remove(0);
            let br = right.records.remove(0);
            pn.keys[pos] = right.keys[0].clone();
            child.keys.push(bk); child.records.push(br);
        } else {
            let sep = pn.keys[pos].clone();
            let ns = right.keys.remove(0);
            let bc = right.children.remove(0);
            pn.keys[pos] = ns; child.keys.push(sep); child.children.push(bc);
        }
        self.storage.write_node(parent, &pn);
        self.storage.write_node(cid, &child);
        self.storage.write_node(rid, &right);
    }

    fn borrow_from_left(&mut self, parent: usize, pos: usize) {
        let mut pn = self.storage.read_node(parent);
        let cid = pn.children[pos];
        let lid = pn.children[pos - 1];
        let mut child = self.storage.read_node(cid);
        let mut left = self.storage.read_node(lid);
        if child.is_leaf() {
            let lk = left.keys.pop().unwrap();
            let lr = left.records.pop().unwrap();
            pn.keys[pos - 1] = lk.clone();
            child.keys.insert(0, lk); child.records.insert(0, lr);
        } else {
            let sep = pn.keys[pos - 1].clone();
            let ns = left.keys.pop().unwrap();
            let bc = left.children.pop().unwrap();
            pn.keys[pos - 1] = ns; child.keys.insert(0, sep); child.children.insert(0, bc);
        }
        self.storage.write_node(parent, &pn);
        self.storage.write_node(cid, &child);
        self.storage.write_node(lid, &left);
    }

    fn merge(&mut self, parent: usize, left_pos: usize) {
        let mut pn = self.storage.read_node(parent);
        let lid = pn.children[left_pos];
        let rid = pn.children[left_pos + 1];
        let mut left = self.storage.read_node(lid);
        let right = self.storage.read_node(rid);
        if left.is_leaf() {
            left.keys.extend(right.keys); left.records.extend(right.records);
            left.next_leaf = right.next_leaf;
        } else {
            let sep = pn.keys[left_pos].clone();
            left.keys.push(sep); left.keys.extend(right.keys);
            left.children.extend(right.children);
        }
        pn.keys.remove(left_pos); pn.children.remove(left_pos + 1);
        self.storage.write_node(lid, &left);
        self.storage.write_node(parent, &pn);
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::pager::storage::MemoryStorage;

    fn int_key(v: i64) -> Key { Key::Integer(v) }
    fn val(s: &str) -> Vec<u8> { s.as_bytes().to_vec() }
    fn new_tree() -> BPlusTree<MemoryStorage> { BPlusTree::new(4, MemoryStorage::new()) }

    #[test]
    fn test_insert_and_search() {
        let mut tree = new_tree();
        tree.insert(int_key(10), val("Alice"));
        tree.insert(int_key(20), val("Bob"));
        tree.insert(int_key(5),  val("Carol"));
        assert_eq!(tree.search(&int_key(10)), Some(b"Alice".to_vec()));
        assert_eq!(tree.search(&int_key(20)), Some(b"Bob".to_vec()));
        assert_eq!(tree.search(&int_key(5)),  Some(b"Carol".to_vec()));
        assert_eq!(tree.search(&int_key(99)), None);
    }

    #[test]
    fn test_insert_many_triggers_split() {
        let mut tree = new_tree();
        for i in 0..20i64 { tree.insert(int_key(i), val("x")); }
        assert_eq!(tree.len(), 20);
        for i in 0..20i64 { assert!(tree.search(&int_key(i)).is_some(), "key {} missing", i); }
    }

    #[test]
    fn test_range_search() {
        let mut tree = new_tree();
        for i in 1..=10i64 { tree.insert(int_key(i), val("v")); }
        let result = tree.range_search(&int_key(3), &int_key(7));
        let keys: Vec<i64> = result.iter().map(|r| match r.key { Key::Integer(v) => v, _ => panic!() }).collect();
        assert_eq!(keys, vec![3, 4, 5, 6, 7]);
    }

    #[test]
    fn test_delete() {
        let mut tree = new_tree();
        for i in 1..=10i64 { tree.insert(int_key(i), val("v")); }
        assert!(tree.delete(&int_key(5)));
        assert_eq!(tree.search(&int_key(5)), None);
        assert_eq!(tree.len(), 9);
        assert!(!tree.delete(&int_key(99)));
    }

    #[test]
    fn test_update() {
        let mut tree = new_tree();
        tree.insert(int_key(1), val("old"));
        tree.insert(int_key(1), val("new"));
        assert_eq!(tree.search(&int_key(1)), Some(b"new".to_vec()));
        assert_eq!(tree.len(), 1);
    }

    #[test]
    fn test_text_key() {
        let mut tree = new_tree();
        tree.insert(Key::Text("banana".into()), val("fruit"));
        tree.insert(Key::Text("apple".into()),  val("also fruit"));
        assert_eq!(tree.search(&Key::Text("banana".into())), Some(b"fruit".to_vec()));
    }

    #[test]
    fn test_disk_storage_persist() {
        use crate::pager::storage::DiskStorage;
        let path = "/tmp/sql5_btree_test.sql5db";
        let _ = std::fs::remove_file(path);
        let root_page;
        {
            let store = DiskStorage::open(path).unwrap();
            let mut tree = BPlusTree::new(4, store);
            for i in 1..=5i64 { tree.insert(int_key(i), val("persisted")); }
            root_page = tree.root_page();
            tree.flush();
        }
        {
            let store = DiskStorage::open(path).unwrap();
            let mut tree = BPlusTree::open(4, store, root_page, 5);
            for i in 1..=5i64 {
                assert_eq!(tree.search(&int_key(i)), Some(b"persisted".to_vec()), "key {} missing after reopen", i);
            }
        }
        let _ = std::fs::remove_file(path);
    }
}