Update REAMDE.md

README.md

@@ -1,71 +1,11 @@
-# bustubx - a relational database for educational purpose (CMU 15-445)
-- DDL
-  - [x] Create
-    - [x] Create Table
-    - [x] Create Index
-  - [ ] Drop
-  - [ ] Alter
-  - [ ] Truncate
-- DQL
-  - [x] Select
-  - [x] Where
-  - [ ] Distinct
-  - [ ] Aggregation: Count / Sum / Avg / Min / Max
-  - [ ] Subquery
-  - [ ] Join: Left Outer / Right Outer / Full Outer / Inner / Cross
-  - [ ] Group By
-  - [ ] Having
-  - [x] Order By
-  - [x] Limit
-- DML
-  - [x] Insert
-  - [ ] Update
-  - [ ] Delete
-- Data Types
-  - [x] Bool
-  - [x] TinyInt
-  - [x] SmallInt
-  - [x] Integer
-  - [x] BigInt
-  - [ ] Float
-  - [ ] Varchar
-  - [ ] Null
-- Optimizer rules
-  - [x] Limit Project Transpose
-  - [x] Eliminate Limits
-  - [x] Push Limit Through Join
-  - [ ] Push Limit Into Scan
-  - [ ] Combine Filters
-  - [ ] Column Pruning
-  - [ ] Collapse Project
-- Executors
-  - [x] Create Table
-  - [x] Create Index
-  - [x] Table Scan
-  - [ ] Index Scan
-  - [x] Filter
-  - [x] Project
-  - [x] Limit
-  - [x] Nested Loop Join
-  - [ ] Hash Join
-  - [x] Sort
-  - [x] Insert
-  - [x] Values
-  - [ ] Update
-  - [ ] Delete
-- Transaction
-  - [ ] Begin
-  - [ ] Commit
-  - [ ] Rollback
-  - [ ] Isolation Level
-    - [ ] Read Uncommitted
-    - [ ] Read Committed
-    - [ ] Repeatable Read
-    - [ ] Serializable
-- Recovery
-  - [ ] Redo
-  - [ ] Undo
-  - [ ] Checkpoint
+# BustubX - a relational database for educational purpose (CMU 15-445)
+- [ ] DML
+- [ ] DDL
+- [ ] Rule-based Optimizer
+- [ ] Parallel Execution
+- [ ] B+ Tree Index
+- [ ] Multi-Version Concurrency Control
+- [ ] Crash Recovery
 
 ## Architecture
 ![architecture](./docs/bustubx-architecture.png)
@@ -74,19 +14,7 @@
 ## Get started
 Install rust toolchain first.
 ```
-cargo run
-```
-test command
-```mysql
-create table t1(a int, b int);
-
-insert into t1 values(1,1),(2,3),(5,4);
-
-select * from t1;
-
-select * from t1 where a <= b;
-
-select a from t1 where a <= b;
+cargo run --bin bustubx-cli
 ```
 
 ![demo](./docs/bustubx-demo.png)
@@ -99,9 +27,4 @@ select a from t1 where a <= b;
 - [talent-plan/tinysql](https://github.com/talent-plan/tinysql)
 - [CMU 15-445课程笔记-zhenghe](https://zhenghe.gitbook.io/open-courses/cmu-15-445-645-database-systems/relational-data-model)
 - [CMU15-445 22Fall通关记录 - 知乎](https://www.zhihu.com/column/c_1605901992903004160)
-- [B+ Tree Visualization](https://www.cs.usfca.edu/~galles/visualization/BPlusTree.html)
-
-## Questions
-**1.What if same keys in B+ tree node?**
-
-**2.What if key size exceeds b+ tree index page capacity?**
+- [B+ Tree Visualization](https://www.cs.usfca.edu/~galles/visualization/BPlusTree.html)

bustubx/src/execution/physical_plan/filter.rs

@@ -1,4 +1,5 @@
 use std::sync::Arc;
+use tracing::debug;
 
 use crate::catalog::SchemaRef;
 use crate::expression::{Expr, ExprTrait};
@@ -19,7 +20,7 @@ pub struct PhysicalFilter {
 
 impl VolcanoExecutor for PhysicalFilter {
     fn init(&self, context: &mut ExecutionContext) -> BustubxResult<()> {
-        println!("init filter executor");
+        debug!("init filter executor");
         self.input.init(context)
     }
 

bustubx/src/execution/physical_plan/limit.rs

@@ -1,8 +1,8 @@
 use std::sync::{atomic::AtomicU32, Arc};
+use tracing::debug;
 
 use crate::catalog::SchemaRef;
 use crate::{
-    catalog::Schema,
     execution::{ExecutionContext, VolcanoExecutor},
     storage::Tuple,
     BustubxResult,
@@ -30,7 +30,7 @@ impl PhysicalLimit {
 }
 impl VolcanoExecutor for PhysicalLimit {
     fn init(&self, context: &mut ExecutionContext) -> BustubxResult<()> {
-        println!("init limit executor");
+        debug!("init limit executor");
         self.cursor.store(0, std::sync::atomic::Ordering::SeqCst);
         self.input.init(context)
     }

bustubx/src/execution/physical_plan/nested_loop_join.rs

@@ -1,4 +1,5 @@
 use std::sync::{Arc, Mutex};
+use tracing::debug;
 
 use crate::catalog::SchemaRef;
 use crate::expression::{Expr, ExprTrait};
@@ -43,7 +44,7 @@ impl PhysicalNestedLoopJoin {
 }
 impl VolcanoExecutor for PhysicalNestedLoopJoin {
     fn init(&self, context: &mut ExecutionContext) -> BustubxResult<()> {
-        println!("init nested loop join executor");
+        debug!("init nested loop join executor");
         *self.left_tuple.lock().unwrap() = None;
         self.left_input.init(context)?;
         self.right_input.init(context)

bustubx/src/execution/physical_plan/project.rs

@@ -1,4 +1,5 @@
 use std::sync::Arc;
+use tracing::debug;
 
 use crate::catalog::SchemaRef;
 use crate::expression::{Expr, ExprTrait};
@@ -19,7 +20,7 @@ pub struct PhysicalProject {
 
 impl VolcanoExecutor for PhysicalProject {
     fn init(&self, context: &mut ExecutionContext) -> BustubxResult<()> {
-        println!("init project executor");
+        debug!("init project executor");
         self.input.init(context)
     }
 

bustubx/src/execution/physical_plan/seq_scan.rs

@@ -1,4 +1,5 @@
 use std::sync::Mutex;
+use tracing::debug;
 
 use crate::catalog::SchemaRef;
 use crate::common::TableReference;
@@ -28,7 +29,7 @@ impl PhysicalSeqScan {
 
 impl VolcanoExecutor for PhysicalSeqScan {
     fn init(&self, context: &mut ExecutionContext) -> BustubxResult<()> {
-        println!("init table scan executor");
+        debug!("init table scan executor");
         let table_info = context
             .catalog
             .get_mut_table_by_name(self.table.table())

bustubx/src/execution/physical_plan/sort.rs

@@ -1,4 +1,5 @@
 use std::sync::{atomic::AtomicU32, Arc, Mutex};
+use tracing::debug;
 
 use crate::catalog::SchemaRef;
 use crate::expression::ExprTrait;
@@ -31,7 +32,7 @@ impl PhysicalSort {
 }
 impl VolcanoExecutor for PhysicalSort {
     fn init(&self, context: &mut ExecutionContext) -> BustubxResult<()> {
-        println!("init sort executor");
+        debug!("init sort executor");
         self.input.init(context)?;
         // TODO move to next method
         // load all tuples from input