quill-sql 0.2.1

An educational Rust relational database (RDBMS) inspired by CMU 15445
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
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
use crate::buffer::{AtomicPageId, PageId, INVALID_PAGE_ID};
use crate::catalog::catalog::{CatalogSchema, CatalogTable};
use crate::catalog::{
    Catalog, Column, DataType, Schema, SchemaRef, DEFAULT_CATALOG_NAME, DEFAULT_SCHEMA_NAME,
};
use crate::database::Database;
use crate::error::{QuillSQLError, QuillSQLResult};
use crate::utils::scalar::ScalarValue;
use crate::utils::table_ref::TableReference;

use crate::storage::index::btree_index::BPlusTreeIndex;
use crate::storage::table_heap::{TableHeap, TableIterator};
use std::collections::HashMap;
use std::sync::{Arc, LazyLock};

pub static INFORMATION_SCHEMA_NAME: &str = "information_schema";
pub static INFORMATION_SCHEMA_SCHEMAS: &str = "schemas";
pub static INFORMATION_SCHEMA_TABLES: &str = "tables";
pub static INFORMATION_SCHEMA_COLUMNS: &str = "columns";
pub static INFORMATION_SCHEMA_INDEXES: &str = "indexes";

pub static SCHEMAS_SCHEMA: LazyLock<SchemaRef> = LazyLock::new(|| {
    Arc::new(Schema::new(vec![
        Column::new("catalog", DataType::Varchar(None), false),
        Column::new("schema", DataType::Varchar(None), false),
    ]))
});

pub static TABLES_SCHEMA: LazyLock<SchemaRef> = LazyLock::new(|| {
    Arc::new(Schema::new(vec![
        Column::new("table_catalog", DataType::Varchar(None), false),
        Column::new("table_schema", DataType::Varchar(None), false),
        Column::new("table_name", DataType::Varchar(None), false),
        Column::new("first_page_id", DataType::UInt32, false),
    ]))
});

pub static COLUMNS_SCHEMA: LazyLock<SchemaRef> = LazyLock::new(|| {
    Arc::new(Schema::new(vec![
        Column::new("table_catalog", DataType::Varchar(None), false),
        Column::new("table_schema", DataType::Varchar(None), false),
        Column::new("table_name", DataType::Varchar(None), false),
        Column::new("column_name", DataType::Varchar(None), false),
        Column::new("data_type", DataType::Varchar(None), false),
        Column::new("nullable", DataType::Boolean, false),
        Column::new("default", DataType::Varchar(None), false),
    ]))
});

pub static INDEXES_SCHEMA: LazyLock<SchemaRef> = LazyLock::new(|| {
    Arc::new(Schema::new(vec![
        Column::new("table_catalog", DataType::Varchar(None), false),
        Column::new("table_schema", DataType::Varchar(None), false),
        Column::new("table_name", DataType::Varchar(None), false),
        Column::new("index_name", DataType::Varchar(None), false),
        Column::new("key_schema", DataType::Varchar(None), false),
        Column::new("internal_max_size", DataType::UInt32, false),
        Column::new("leaf_max_size", DataType::UInt32, false),
        Column::new("header_page_id", DataType::UInt32, false),
    ]))
});

pub fn load_catalog_data(db: &mut Database) -> QuillSQLResult<()> {
    load_information_schema(&mut db.catalog)?;
    load_schemas(db)?;
    create_default_schema_if_not_exists(&mut db.catalog)?;
    load_user_tables(db)?;
    load_user_indexes(db)?;
    Ok(())
}

fn create_default_schema_if_not_exists(catalog: &mut Catalog) -> QuillSQLResult<()> {
    if !catalog.schemas.contains_key(DEFAULT_SCHEMA_NAME) {
        catalog.create_schema(DEFAULT_SCHEMA_NAME)?;
    }
    Ok(())
}

fn load_information_schema(catalog: &mut Catalog) -> QuillSQLResult<()> {
    let meta = catalog.disk_manager.meta.read().unwrap();
    let information_schema_schemas_first_page_id = meta.information_schema_schemas_first_page_id;
    let information_schema_tables_first_page_id = meta.information_schema_tables_first_page_id;
    let information_schema_columns_first_page_id = meta.information_schema_columns_first_page_id;
    let information_schema_indexes_first_page_id = meta.information_schema_indexes_first_page_id;
    drop(meta);

    // load last page id
    let information_schema_schemas_last_page_id = load_table_last_page_id(
        catalog,
        information_schema_schemas_first_page_id,
        SCHEMAS_SCHEMA.clone(),
    )?;
    let information_schema_tables_last_page_id = load_table_last_page_id(
        catalog,
        information_schema_tables_first_page_id,
        TABLES_SCHEMA.clone(),
    )?;
    let information_schema_columns_last_page_id = load_table_last_page_id(
        catalog,
        information_schema_columns_first_page_id,
        COLUMNS_SCHEMA.clone(),
    )?;
    let information_schema_indexes_last_page_id = load_table_last_page_id(
        catalog,
        information_schema_indexes_first_page_id,
        INDEXES_SCHEMA.clone(),
    )?;

    let table_registry = catalog.table_registry();
    let mut information_schema = CatalogSchema::new(INFORMATION_SCHEMA_NAME);

    let schemas_table = TableHeap {
        schema: SCHEMAS_SCHEMA.clone(),
        buffer_pool: catalog.buffer_pool.clone(),
        first_page_id: AtomicPageId::new(information_schema_schemas_first_page_id),
        last_page_id: AtomicPageId::new(information_schema_schemas_last_page_id),
    };
    let schemas_heap = Arc::new(schemas_table);
    information_schema.tables.insert(
        INFORMATION_SCHEMA_SCHEMAS.to_string(),
        CatalogTable::new(INFORMATION_SCHEMA_SCHEMAS, schemas_heap.clone()),
    );
    table_registry.register(
        TableReference::Full {
            catalog: DEFAULT_CATALOG_NAME.to_string(),
            schema: INFORMATION_SCHEMA_NAME.to_string(),
            table: INFORMATION_SCHEMA_SCHEMAS.to_string(),
        },
        schemas_heap,
    );

    let tables_table = TableHeap {
        schema: TABLES_SCHEMA.clone(),
        buffer_pool: catalog.buffer_pool.clone(),
        first_page_id: AtomicPageId::new(information_schema_tables_first_page_id),
        last_page_id: AtomicPageId::new(information_schema_tables_last_page_id),
    };
    let tables_heap = Arc::new(tables_table);
    information_schema.tables.insert(
        INFORMATION_SCHEMA_TABLES.to_string(),
        CatalogTable::new(INFORMATION_SCHEMA_TABLES, tables_heap.clone()),
    );
    table_registry.register(
        TableReference::Full {
            catalog: DEFAULT_CATALOG_NAME.to_string(),
            schema: INFORMATION_SCHEMA_NAME.to_string(),
            table: INFORMATION_SCHEMA_TABLES.to_string(),
        },
        tables_heap,
    );

    let columns_table = TableHeap {
        schema: COLUMNS_SCHEMA.clone(),
        buffer_pool: catalog.buffer_pool.clone(),
        first_page_id: AtomicPageId::new(information_schema_columns_first_page_id),
        last_page_id: AtomicPageId::new(information_schema_columns_last_page_id),
    };
    let columns_heap = Arc::new(columns_table);
    information_schema.tables.insert(
        INFORMATION_SCHEMA_COLUMNS.to_string(),
        CatalogTable::new(INFORMATION_SCHEMA_COLUMNS, columns_heap.clone()),
    );
    table_registry.register(
        TableReference::Full {
            catalog: DEFAULT_CATALOG_NAME.to_string(),
            schema: INFORMATION_SCHEMA_NAME.to_string(),
            table: INFORMATION_SCHEMA_COLUMNS.to_string(),
        },
        columns_heap,
    );

    let indexes_table = TableHeap {
        schema: INDEXES_SCHEMA.clone(),
        buffer_pool: catalog.buffer_pool.clone(),
        first_page_id: AtomicPageId::new(information_schema_indexes_first_page_id),
        last_page_id: AtomicPageId::new(information_schema_indexes_last_page_id),
    };
    let indexes_heap = Arc::new(indexes_table);
    information_schema.tables.insert(
        INFORMATION_SCHEMA_INDEXES.to_string(),
        CatalogTable::new(INFORMATION_SCHEMA_INDEXES, indexes_heap.clone()),
    );
    table_registry.register(
        TableReference::Full {
            catalog: DEFAULT_CATALOG_NAME.to_string(),
            schema: INFORMATION_SCHEMA_NAME.to_string(),
            table: INFORMATION_SCHEMA_INDEXES.to_string(),
        },
        indexes_heap,
    );

    catalog.load_schema(INFORMATION_SCHEMA_NAME, information_schema);
    Ok(())
}

fn load_schemas(db: &mut Database) -> QuillSQLResult<()> {
    let schemas_table = {
        let information_schema =
            db.catalog
                .schemas
                .get(INFORMATION_SCHEMA_NAME)
                .ok_or_else(|| {
                    QuillSQLError::Internal("information_schema not initialized".to_string())
                })?;
        information_schema
            .tables
            .get(INFORMATION_SCHEMA_SCHEMAS)
            .ok_or_else(|| {
                QuillSQLError::Internal("information_schema.schemas missing".to_string())
            })?
            .table
            .clone()
    };

    let mut iterator = TableIterator::new(schemas_table, ..);
    while let Some((_rid, meta, tuple)) = iterator.next()? {
        if meta.is_deleted {
            continue;
        }
        let ScalarValue::Varchar(Some(_catalog)) = tuple.value(0)? else {
            return Err(QuillSQLError::Internal(
                "invalid catalog value in information_schema.schemas".to_string(),
            ));
        };
        let ScalarValue::Varchar(Some(schema_name)) = tuple.value(1)? else {
            return Err(QuillSQLError::Internal(
                "invalid schema value in information_schema.schemas".to_string(),
            ));
        };
        db.catalog
            .load_schema(schema_name.clone(), CatalogSchema::new(schema_name));
    }
    Ok(())
}

fn load_user_tables(db: &mut Database) -> QuillSQLResult<()> {
    let (columns_heap, tables_heap) = {
        let information_schema =
            db.catalog
                .schemas
                .get(INFORMATION_SCHEMA_NAME)
                .ok_or_else(|| {
                    QuillSQLError::Internal("information_schema not initialized".to_string())
                })?;
        let columns_heap = information_schema
            .tables
            .get(INFORMATION_SCHEMA_COLUMNS)
            .ok_or_else(|| {
                QuillSQLError::Internal("information_schema.columns missing".to_string())
            })?
            .table
            .clone();
        let tables_heap = information_schema
            .tables
            .get(INFORMATION_SCHEMA_TABLES)
            .ok_or_else(|| {
                QuillSQLError::Internal("information_schema.tables missing".to_string())
            })?
            .table
            .clone();
        (columns_heap, tables_heap)
    };

    let mut column_map: HashMap<(String, String, String), Vec<Column>> = HashMap::new();
    let mut column_iter = TableIterator::new(columns_heap, ..);
    while let Some((_rid, meta, tuple)) = column_iter.next()? {
        if meta.is_deleted {
            continue;
        }
        let ScalarValue::Varchar(Some(catalog)) = tuple.value(0)? else {
            return Err(QuillSQLError::Internal(
                "invalid catalog in information_schema.columns".to_string(),
            ));
        };
        let ScalarValue::Varchar(Some(schema)) = tuple.value(1)? else {
            return Err(QuillSQLError::Internal(
                "invalid schema in information_schema.columns".to_string(),
            ));
        };
        let ScalarValue::Varchar(Some(table)) = tuple.value(2)? else {
            return Err(QuillSQLError::Internal(
                "invalid table in information_schema.columns".to_string(),
            ));
        };
        let ScalarValue::Varchar(Some(column_name)) = tuple.value(3)? else {
            return Err(QuillSQLError::Internal(
                "invalid column name in information_schema.columns".to_string(),
            ));
        };
        let ScalarValue::Varchar(Some(data_type_str)) = tuple.value(4)? else {
            return Err(QuillSQLError::Internal(
                "invalid data type in information_schema.columns".to_string(),
            ));
        };
        let ScalarValue::Boolean(Some(nullable)) = tuple.value(5)? else {
            return Err(QuillSQLError::Internal(
                "invalid nullable flag in information_schema.columns".to_string(),
            ));
        };
        let ScalarValue::Varchar(Some(default)) = tuple.value(6)? else {
            return Err(QuillSQLError::Internal(
                "invalid default in information_schema.columns".to_string(),
            ));
        };

        let data_type: DataType = data_type_str.as_str().try_into()?;
        let default_value = ScalarValue::from_string(default, data_type)?;
        column_map
            .entry((catalog.clone(), schema.clone(), table.clone()))
            .or_default()
            .push(
                Column::new(column_name.clone(), data_type, *nullable).with_default(default_value),
            );
    }

    let mut table_iter = TableIterator::new(tables_heap, ..);
    while let Some((_rid, meta, tuple)) = table_iter.next()? {
        if meta.is_deleted {
            continue;
        }
        let ScalarValue::Varchar(Some(catalog)) = tuple.value(0)? else {
            return Err(QuillSQLError::Internal(
                "invalid catalog in information_schema.tables".to_string(),
            ));
        };
        let ScalarValue::Varchar(Some(schema)) = tuple.value(1)? else {
            return Err(QuillSQLError::Internal(
                "invalid schema in information_schema.tables".to_string(),
            ));
        };
        let ScalarValue::Varchar(Some(table)) = tuple.value(2)? else {
            return Err(QuillSQLError::Internal(
                "invalid table name in information_schema.tables".to_string(),
            ));
        };
        let ScalarValue::UInt32(Some(first_page_id)) = tuple.value(3)? else {
            return Err(QuillSQLError::Internal(
                "invalid first_page_id in information_schema.tables".to_string(),
            ));
        };

        let columns = column_map
            .remove(&(catalog.clone(), schema.clone(), table.clone()))
            .unwrap_or_default();
        let schema_ref = Arc::new(Schema::new(columns));

        let last_page_id =
            load_table_last_page_id(&mut db.catalog, *first_page_id, schema_ref.clone())?;
        let table_heap = TableHeap {
            schema: schema_ref.clone(),
            buffer_pool: db.buffer_pool.clone(),
            first_page_id: AtomicPageId::new(*first_page_id),
            last_page_id: AtomicPageId::new(last_page_id),
        };

        db.catalog.load_table(
            TableReference::Full {
                catalog: catalog.to_string(),
                schema: schema.to_string(),
                table: table.to_string(),
            },
            CatalogTable::new(table, Arc::new(table_heap)),
        )?;
    }
    Ok(())
}

fn load_user_indexes(db: &mut Database) -> QuillSQLResult<()> {
    let indexes_heap = {
        let information_schema =
            db.catalog
                .schemas
                .get(INFORMATION_SCHEMA_NAME)
                .ok_or_else(|| {
                    QuillSQLError::Internal("information_schema not initialized".to_string())
                })?;

        information_schema
            .tables
            .get(INFORMATION_SCHEMA_INDEXES)
            .ok_or_else(|| {
                QuillSQLError::Internal("information_schema.indexes missing".to_string())
            })?
            .table
            .clone()
    };

    let mut iterator = TableIterator::new(indexes_heap, ..);
    while let Some((_rid, meta, tuple)) = iterator.next()? {
        if meta.is_deleted {
            continue;
        }
        let ScalarValue::Varchar(Some(catalog_name)) = tuple.value(0)? else {
            return Err(QuillSQLError::Internal(
                "invalid catalog in information_schema.indexes".to_string(),
            ));
        };
        let ScalarValue::Varchar(Some(table_schema_name)) = tuple.value(1)? else {
            return Err(QuillSQLError::Internal(
                "invalid schema in information_schema.indexes".to_string(),
            ));
        };
        let ScalarValue::Varchar(Some(table_name)) = tuple.value(2)? else {
            return Err(QuillSQLError::Internal(
                "invalid table in information_schema.indexes".to_string(),
            ));
        };
        let ScalarValue::Varchar(Some(index_name)) = tuple.value(3)? else {
            return Err(QuillSQLError::Internal(
                "invalid index name in information_schema.indexes".to_string(),
            ));
        };
        let ScalarValue::Varchar(Some(key_schema_str)) = tuple.value(4)? else {
            return Err(QuillSQLError::Internal(
                "invalid key schema in information_schema.indexes".to_string(),
            ));
        };
        let ScalarValue::UInt32(Some(internal_max_size)) = tuple.value(5)? else {
            return Err(QuillSQLError::Internal(
                "invalid internal max size in information_schema.indexes".to_string(),
            ));
        };
        let ScalarValue::UInt32(Some(leaf_max_size)) = tuple.value(6)? else {
            return Err(QuillSQLError::Internal(
                "invalid leaf max size in information_schema.indexes".to_string(),
            ));
        };
        let ScalarValue::UInt32(Some(header_page_id)) = tuple.value(7)? else {
            return Err(QuillSQLError::Internal(
                "invalid header page id in information_schema.indexes".to_string(),
            ));
        };

        let table_ref = TableReference::Full {
            catalog: catalog_name.clone(),
            schema: table_schema_name.clone(),
            table: table_name.clone(),
        };
        let table_schema = db.catalog.table_heap(&table_ref)?.schema.clone();
        let key_schema = Arc::new(parse_key_schema_from_varchar(
            key_schema_str.as_str(),
            table_schema,
        )?);

        let b_plus_tree_index = BPlusTreeIndex::open(
            key_schema,
            db.buffer_pool.clone(),
            *internal_max_size,
            *leaf_max_size,
            *header_page_id,
        );
        db.catalog
            .load_index(table_ref, index_name, Arc::new(b_plus_tree_index))?;
    }
    Ok(())
}

fn load_table_last_page_id(
    catalog: &mut Catalog,
    first_page_id: PageId,
    schema: SchemaRef,
) -> QuillSQLResult<PageId> {
    let mut page_id = first_page_id;
    loop {
        let (_, table_page) = catalog
            .buffer_pool
            .fetch_table_page(page_id, schema.clone())?;

        if table_page.header.next_page_id == INVALID_PAGE_ID {
            return Ok(page_id);
        } else {
            page_id = table_page.header.next_page_id;
        }
    }
}

pub fn key_schema_to_varchar(key_schema: &Schema) -> String {
    key_schema
        .columns
        .iter()
        .map(|col| col.name.as_str())
        .collect::<Vec<_>>()
        .join(", ")
}

fn parse_key_schema_from_varchar(varchar: &str, table_schema: SchemaRef) -> QuillSQLResult<Schema> {
    let column_names = varchar
        .split(",")
        .map(|name| name.trim())
        .collect::<Vec<&str>>();
    let indices = column_names
        .into_iter()
        .map(|name| table_schema.index_of(None, name))
        .collect::<QuillSQLResult<Vec<usize>>>()?;
    table_schema.project(&indices)
}