sql5 3.2.18

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
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
//! Catalog:資料庫的「資料字典」
//!
//! 負責:
//!   - 記錄所有 Table 的 schema 與根頁號
//!   - 提供 create_table / drop_table / get_table
//!   - 自身也透過 B+Tree 持久化(系統表 `__catalog__`)
//!
//! 使用範例:
//! ```rust
//! use sql5::catalog::Catalog;
//! use sql5::table::schema::{Column, DataType, Schema};
//! use sql5::pager::MemoryStorage;
//!
//! let mut catalog = Catalog::new(MemoryStorage::new());
//! let schema = Schema::new(vec![
//!     Column::new("id",   DataType::Integer),
//!     Column::new("name", DataType::Text),
//! ]);
//! catalog.create_table("users", schema).unwrap();
//! assert!(catalog.get_table("users").is_some());
//! ```

use std::collections::HashMap;

use crate::btree::node::Key;
use crate::btree::tree::BPlusTree;
use crate::pager::storage::Storage;
use crate::table::schema::Schema;

use super::meta::{decode_meta, encode_meta, TableMeta, IndexMeta, ViewMeta, TriggerMeta, TriggerTiming, TriggerEvent, encode_trigger, decode_trigger};
use crate::table::schema::Column;

pub struct Catalog<S: Storage> {
    /// 系統表:以表名為 key,儲存 TableMeta 的序列化結果
    sys_tree: BPlusTree<S>,
    /// 記憶體快取,避免每次都反序列化
    cache: HashMap<String, TableMeta>,
    /// 索引快取
    index_cache: HashMap<String, IndexMeta>,
    /// 視圖快取
    view_cache: HashMap<String, ViewMeta>,
    /// trigger 快取
    trigger_cache: HashMap<String, TriggerMeta>,
}

impl<S: Storage> Catalog<S> {
    // ------------------------------------------------------------------ //
    //  建構                                                                //
    // ------------------------------------------------------------------ //

    /// 建立全新的 Catalog(全新資料庫)
    pub fn new(storage: S) -> Self {
        let sys_tree = BPlusTree::new(64, storage);
        Catalog { sys_tree, cache: HashMap::new(), index_cache: HashMap::new(), view_cache: HashMap::new(), trigger_cache: HashMap::new() }
    }

    /// 開啟已有的 Catalog(從磁碟重新載入)
    pub fn open(storage: S, root_page: usize) -> Self {
        let sys_tree = BPlusTree::open(64, storage, root_page, 0);
        let mut catalog = Catalog { sys_tree, cache: HashMap::new(), index_cache: HashMap::new(), view_cache: HashMap::new(), trigger_cache: HashMap::new() };
        catalog.load_all();
        catalog
    }

    // ------------------------------------------------------------------ //
    //  公開 API                                                            //
    // ------------------------------------------------------------------ //

    /// 建立新資料表;若表名已存在回傳 Err
    pub fn create_table(&mut self, name: &str, schema: Schema) -> Result<&TableMeta, String> {
        if self.cache.contains_key(name) {
            return Err(format!("table '{}' already exists", name));
        }

        // root_page = 0 是佔位值,實際由呼叫端在拿到 Table 後設定
        // 這裡先配置一個代表「尚未使用」的頁號 usize::MAX
        let meta = TableMeta::new(name, schema, usize::MAX);
        self.persist_meta(&meta);
        self.cache.insert(name.to_string(), meta);
        Ok(self.cache.get(name).unwrap())
    }

    /// 更新資料表的 root_page 與 row_count(Table 初始化後呼叫)
    pub fn update_table_meta(&mut self, name: &str, root_page: usize, row_count: usize) -> Result<(), String> {
        self.update_table_meta_full(name, root_page, row_count, None)
    }

    /// 更新資料表(含 autoinc_last)
    pub fn update_table_meta_full(&mut self, name: &str, root_page: usize, row_count: usize, autoinc_last: Option<u64>) -> Result<(), String> {
        let meta = self.cache.get_mut(name)
            .ok_or_else(|| format!("table '{}' not found", name))?;
        meta.root_page = root_page;
        meta.row_count = row_count;
        if let Some(v) = autoinc_last {
            meta.autoinc_last = v;
        }
        let meta_clone = meta.clone();
        self.persist_meta(&meta_clone);
        Ok(())
    }

    /// 查詢資料表定義;找不到回傳 None
    pub fn get_table(&self, name: &str) -> Option<&TableMeta> {
        self.cache.get(name)
    }

    /// 取得可變參照
    pub fn get_table_mut(&mut self, name: &str) -> Option<&mut TableMeta> {
        self.cache.get_mut(name)
    }

    /// 刪除資料表;找不到回傳 Err
    pub fn drop_table(&mut self, name: &str) -> Result<(), String> {
        if self.cache.remove(name).is_none() {
            return Err(format!("table '{}' not found", name));
        }
        self.sys_tree.delete(&Key::Text(name.to_string()));
        Ok(())
    }

    /// 列出所有資料表名稱
    pub fn table_names(&self) -> Vec<&str> {
        self.cache.keys().map(|s| s.as_str()).collect()
    }

    /// 資料表是否存在
    pub fn table_exists(&self, name: &str) -> bool {
        self.cache.contains_key(name)
    }

    /// 建立索引
    pub fn create_index(&mut self, name: &str, table: &str, columns: &[String], unique: bool) -> Result<(), String> {
        if self.index_cache.contains_key(name) {
            return Err(format!("index '{}' already exists", name));
        }
        if !self.table_exists(table) {
            return Err(format!("table '{}' does not exist", table));
        }
        let meta = IndexMeta::new(name, table, columns, unique);
        self.index_cache.insert(name.to_string(), meta);
        Ok(())
    }

    /// 刪除索引
    pub fn drop_index(&mut self, name: &str) -> Result<(), String> {
        if self.index_cache.remove(name).is_none() {
            return Err(format!("index '{}' not found", name));
        }
        Ok(())
    }

    /// 索引是否存在
    pub fn index_exists(&self, name: &str) -> bool {
        self.index_cache.contains_key(name)
    }

    /// 取得索引
    pub fn get_index(&self, name: &str) -> Option<&IndexMeta> {
        self.index_cache.get(name)
    }

    /// 列出所有索引名稱
    pub fn index_names(&self) -> Vec<&str> {
        self.index_cache.keys().map(|s| s.as_str()).collect()
    }

    /// 建立視圖
    pub fn create_view(&mut self, name: &str, query: &str) -> Result<(), String> {
        if self.view_cache.contains_key(name) {
            return Err(format!("view '{}' already exists", name));
        }
        self.view_cache.insert(name.to_string(), ViewMeta::new(name, query));
        Ok(())
    }

    /// 刪除視圖
    pub fn drop_view(&mut self, name: &str) -> Result<(), String> {
        if self.view_cache.remove(name).is_none() {
            return Err(format!("view '{}' not found", name));
        }
        Ok(())
    }

    /// 視圖是否存在
    pub fn view_exists(&self, name: &str) -> bool {
        self.view_cache.contains_key(name)
    }

    /// 取得視圖
    pub fn get_view(&self, name: &str) -> Option<&ViewMeta> {
        self.view_cache.get(name)
    }

    /// 列出所有視圖名稱
    pub fn view_names(&self) -> Vec<&str> {
        self.view_cache.keys().map(|s| s.as_str()).collect()
    }

    /// 建立 Trigger
    pub fn create_trigger(
        &mut self,
        name: &str,
        table: &str,
        timing: TriggerTiming,
        event: TriggerEvent,
        for_each_row: bool,
        when: Option<String>,
        body: &str,
    ) -> Result<(), String> {
        if self.trigger_cache.contains_key(name) {
            return Err(format!("trigger '{}' already exists", name));
        }
        let meta = TriggerMeta::new(name, table, timing, event, for_each_row, when, body);
        self.persist_trigger(&meta);
        self.trigger_cache.insert(name.to_string(), meta);
        Ok(())
    }

    /// 刪除 Trigger
    pub fn drop_trigger(&mut self, name: &str) -> Result<(), String> {
        if self.trigger_cache.remove(name).is_none() {
            return Err(format!("trigger '{}' not found", name));
        }
        self.remove_trigger_meta(name);
        Ok(())
    }

    /// Trigger 是否存在
    pub fn trigger_exists(&self, name: &str) -> bool {
        self.trigger_cache.contains_key(name)
    }

    /// 列出所有 Trigger 名稱
    pub fn trigger_names(&self) -> Vec<&str> {
        self.trigger_cache.keys().map(|s| s.as_str()).collect()
    }

    /// 取得 Trigger
    pub fn get_trigger(&self, name: &str) -> Option<&TriggerMeta> {
        self.trigger_cache.get(name)
    }

    /// 取得指定資料表的觸發器(依事件類型過濾)
    pub fn get_triggers(&self, table: &str, event: &TriggerEvent) -> Vec<&TriggerMeta> {
        self.trigger_cache
            .values()
            .filter(|t| {
                t.table == table && match (&t.event, event) {
                    (TriggerEvent::Delete, TriggerEvent::Delete) => true,
                    (TriggerEvent::Insert, TriggerEvent::Insert) => true,
                    (TriggerEvent::Update(a), TriggerEvent::Update(b)) => {
                        a.is_none() || b.is_none() || a == b
                    }
                    _ => false,
                }
            })
            .collect()
    }

    /// 重新命名資料表
    pub fn rename_table(&mut self, old_name: &str, new_name: &str) -> Result<(), String> {
        let old_meta = self.cache.remove(old_name)
            .ok_or_else(|| format!("table '{}' not found", old_name))?;
        let mut new_meta = old_meta.clone();
        new_meta.name = new_name.to_string();
        self.persist_meta(&new_meta);
        self.cache.insert(new_name.to_string(), new_meta);
        Ok(())
    }

    /// 新增欄位
    pub fn add_column(&mut self, table: &str, _col_name: &str, col: Column) -> Result<(), String> {
        let meta = self.cache.get_mut(table)
            .ok_or_else(|| format!("table '{}' not found", table))?;
        meta.schema.columns.push(col);
        let meta_clone = meta.clone();
        self.persist_meta(&meta_clone);
        Ok(())
    }

    /// 系統表的根頁號(磁碟後端需要儲存此值以便重新開啟)
    pub fn root_page(&self) -> usize {
        self.sys_tree.root_page()
    }

    pub fn flush(&mut self) {
        self.sys_tree.flush();
    }

    /// 從磁碟重新載入所有 TableMeta(load_all 的公開版)
    pub fn reload(&mut self) {
        self.cache.clear();
        self.load_all();
    }

    // ------------------------------------------------------------------ //
    //  內部輔助                                                            //
    // ------------------------------------------------------------------ //

    fn persist_meta(&mut self, meta: &TableMeta) {
        let key = Key::Text(meta.name.clone());
        let bytes = encode_meta(meta);
        self.sys_tree.insert(key, bytes);
    }

    fn persist_trigger(&mut self, trigger: &TriggerMeta) {
        let key = Key::Text(format!("__trigger:{}", trigger.name));
        let bytes = encode_trigger(trigger);
        self.sys_tree.insert(key, bytes);
    }

    fn remove_trigger_meta(&mut self, name: &str) {
        let key = Key::Text(format!("__trigger:{}", name));
        self.sys_tree.delete(&key);
    }

    /// 啟動時從系統表讀入所有 TableMeta 到快取
    fn load_all(&mut self) {
        let min = Key::Text(String::new());
        let max = Key::Text("\u{10FFFF}".repeat(4));
        let records = self.sys_tree.range_search(&min, &max);
        for record in records {
            let key_str = match &record.key {
                Key::Text(s) => s.clone(),
                Key::Integer(_) => continue,
            };
            if key_str.starts_with("__trigger:") {
                let name = key_str.strip_prefix("__trigger:").unwrap();
                let trigger = decode_trigger(&record.value);
                self.trigger_cache.insert(name.to_string(), trigger);
            } else {
                let meta = decode_meta(&record.value);
                self.cache.insert(meta.name.clone(), meta);
            }
        }
    }

    /// 取得 sqlite_master 的查詢結果(type, name, tbl_name, rootpage, sql)
    pub fn sqlite_master_rows(&self) -> Vec<Vec<crate::table::row::Value>> {
        use crate::table::row::Value;
        let mut rows = Vec::new();

        for meta in self.cache.values() {
            rows.push(vec![
                Value::Text("table".to_string()),
                Value::Text(meta.name.clone()),
                Value::Text(meta.name.clone()),
                Value::Integer(meta.root_page as i64),
                Value::Text(self.table_create_sql(meta)),
            ]);
        }

        for idx in self.index_cache.values() {
            rows.push(vec![
                Value::Text("index".to_string()),
                Value::Text(idx.name.clone()),
                Value::Text(idx.table.clone()),
                Value::Integer(0),
                Value::Text(self.index_create_sql(idx)),
            ]);
        }

        for view in self.view_cache.values() {
            rows.push(vec![
                Value::Text("view".to_string()),
                Value::Text(view.name.clone()),
                Value::Text(String::new()),
                Value::Integer(0),
                Value::Text(self.view_create_sql(view)),
            ]);
        }

        for trigger in self.trigger_cache.values() {
            rows.push(vec![
                Value::Text("trigger".to_string()),
                Value::Text(trigger.name.clone()),
                Value::Text(trigger.table.clone()),
                Value::Integer(0),
                Value::Text(self.trigger_create_sql(trigger)),
            ]);
        }

        rows.sort_by(|a, b| {
            let a_type = match &a[0] { Value::Text(s) => s.as_str(), _ => "" };
            let b_type = match &b[0] { Value::Text(s) => s.as_str(), _ => "" };
            a_type.cmp(b_type).then_with(|| {
                let a_name = match &a[1] { Value::Text(s) => s.as_str(), _ => "" };
                let b_name = match &b[1] { Value::Text(s) => s.as_str(), _ => "" };
                a_name.cmp(b_name)
            })
        });

        rows
    }

    fn table_create_sql(&self, meta: &TableMeta) -> String {
        use crate::table::schema::DataType;
        let cols: Vec<String> = meta.schema.columns.iter().map(|c| {
            let dt = match c.data_type {
                DataType::Integer => "INTEGER",
                DataType::Float   => "REAL",
                DataType::Text    => "TEXT",
                DataType::Boolean => "BOOLEAN",
            };
            format!("{} {}", c.name, dt)
        }).collect();
        format!("CREATE TABLE {} ({})", meta.name, cols.join(", "))
    }

    fn index_create_sql(&self, idx: &IndexMeta) -> String {
        let unique = if idx.unique { "UNIQUE " } else { "" };
        format!("CREATE {}INDEX {} ON {} ({})",
            unique, idx.name, idx.table, idx.columns.join(", "))
    }

    fn view_create_sql(&self, view: &ViewMeta) -> String {
        format!("CREATE VIEW {} AS {}", view.name, view.query)
    }

    fn trigger_create_sql(&self, trigger: &TriggerMeta) -> String {
        let timing = match trigger.timing {
            TriggerTiming::Before => "BEFORE",
            TriggerTiming::After => "AFTER",
            TriggerTiming::InsteadOf => "INSTEAD OF",
        };
        let event = match &trigger.event {
            TriggerEvent::Delete => "DELETE",
            TriggerEvent::Insert => "INSERT",
            TriggerEvent::Update(cols) => {
                if let Some(c) = cols {
                    return format!("CREATE TRIGGER {} {} UPDATE OF {} ON {} BEGIN {}; END",
                        trigger.name, timing, c.join(","), trigger.table, trigger.body);
                }
                "UPDATE"
            }
        };
        let when = match &trigger.when {
            Some(w) => format!(" WHEN {}", w),
            None => String::new(),
        };
        format!("CREATE TRIGGER {} {} {} ON {}{} BEGIN {}; END",
            trigger.name, timing, event, trigger.table, when, trigger.body)
    }

    /// sqlite_master 的欄位名稱
    pub fn sqlite_master_columns() -> Vec<String> {
        vec!["type".to_string(), "name".to_string(), "tbl_name".to_string(),
             "rootpage".to_string(), "sql".to_string()]
    }
}

// ------------------------------------------------------------------ //
//  測試                                                                //
// ------------------------------------------------------------------ //

#[cfg(test)]
mod tests {
    use super::*;
    use crate::pager::storage::{DiskStorage, MemoryStorage};
    use crate::table::schema::{Column, DataType, Schema};

    fn users_schema() -> Schema {
        Schema::new(vec![
            Column::new("id",   DataType::Integer),
            Column::new("name", DataType::Text),
        ])
    }

    fn orders_schema() -> Schema {
        Schema::new(vec![
            Column::new("order_id", DataType::Integer),
            Column::new("amount",   DataType::Float),
        ])
    }

    #[test]
    fn create_and_get() {
        let mut cat = Catalog::new(MemoryStorage::new());
        cat.create_table("users", users_schema()).unwrap();
        let meta = cat.get_table("users").unwrap();
        assert_eq!(meta.name, "users");
        assert_eq!(meta.schema.columns.len(), 2);
    }

    #[test]
    fn create_duplicate_fails() {
        let mut cat = Catalog::new(MemoryStorage::new());
        cat.create_table("users", users_schema()).unwrap();
        assert!(cat.create_table("users", users_schema()).is_err());
    }

    #[test]
    fn drop_table() {
        let mut cat = Catalog::new(MemoryStorage::new());
        cat.create_table("users", users_schema()).unwrap();
        cat.drop_table("users").unwrap();
        assert!(cat.get_table("users").is_none());
        assert!(cat.drop_table("users").is_err());
    }

    #[test]
    fn multiple_tables() {
        let mut cat = Catalog::new(MemoryStorage::new());
        cat.create_table("users",  users_schema()).unwrap();
        cat.create_table("orders", orders_schema()).unwrap();
        assert_eq!(cat.table_names().len(), 2);
        assert!(cat.table_exists("users"));
        assert!(cat.table_exists("orders"));
        assert!(!cat.table_exists("missing"));
    }

    #[test]
    fn update_meta() {
        let mut cat = Catalog::new(MemoryStorage::new());
        cat.create_table("users", users_schema()).unwrap();
        cat.update_table_meta("users", 5, 100).unwrap();
        let meta = cat.get_table("users").unwrap();
        assert_eq!(meta.root_page, 5);
        assert_eq!(meta.row_count, 100);
    }

    #[test]
    fn disk_catalog_persist() {
        let path = "/tmp/sql5_catalog_test.sql5db";
        let _ = std::fs::remove_file(path);

        let root_page;
        {
            let mut cat = Catalog::new(DiskStorage::open(path).unwrap());
            cat.create_table("users",  users_schema()).unwrap();
            cat.create_table("orders", orders_schema()).unwrap();
            cat.update_table_meta("users", 3, 10).unwrap();
            root_page = cat.root_page();
            cat.flush();
        }

        {
            let cat = Catalog::open(DiskStorage::open(path).unwrap(), root_page);
            assert!(cat.table_exists("users"));
            assert!(cat.table_exists("orders"));
            let meta = cat.get_table("users").unwrap();
            assert_eq!(meta.root_page, 3);
            assert_eq!(meta.row_count, 10);
        }

        let _ = std::fs::remove_file(path);
    }
}