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 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580
//! Intermediate representation (IR) and instruction set for an SQL database.
use fmt_derive::{Debug, Display};
use sqlparser::ast::{ColumnOptionDef, DataType};
use crate::{
expr::Expr,
identifier::{SchemaRef, TableRef},
value::Value,
vm::RegisterIndex,
BoundedString,
};
#[derive(Debug, Clone)]
/// The intermediate representation of a query. Made of up [`Instruction`]s.
pub struct IntermediateCode {
pub instrs: Vec<Instruction>,
}
/// The instruction set of OtterSQL.
#[derive(Display, Debug, Clone, PartialEq)]
pub enum Instruction {
/// Load a [`Value`] into a register.
Value { index: RegisterIndex, value: Value },
/// Load a [`Expr`] into a register.
Expr { index: RegisterIndex, expr: Expr },
/// Load an *existing* table given by `name`.
///
/// This will result in a [`Register::TableRef`](`crate::vm::Register::TableRef`) being stored at the
/// given register.
Source {
index: RegisterIndex,
name: TableRef,
},
/// Create a new empty [`Register::TableRef`](`crate::vm::Register::TableRef`).
Empty { index: RegisterIndex },
/// Create a new [`Register::TableRef](`crate::vm::Register::TableRef) pointing to a
/// non-existent table.
NonExistent { index: RegisterIndex },
/// Filter the [`Register::TableRef`](`crate::vm::Register::TableRef`) at `index` using the given expression.
///
/// This represents a `WHERE` clause of a `SELECT` statement in SQL.
Filter { index: RegisterIndex, expr: Expr },
/// Create a projection of the columns of the [`Register::TableRef`](`crate::vm::Register::TableRef`) at `input`.
///
/// The resultant column is added to the [`Register::TableRef`](`crate::vm::Register::TableRef`)
/// at `output`. It must be either an empty table or a table with the same number of rows.
///
/// This represents the column list of the `SELECT` statement in SQL.
Project {
input: RegisterIndex,
output: RegisterIndex,
expr: Expr,
#[display(
"{}",
match alias {
None => "None".to_owned(),
Some(alias) => format!("{}", alias)
}
)]
alias: Option<BoundedString>,
},
/// Group the [`Register::TableRef`](`crate::vm::Register::TableRef`) at `index` by the given expression.
///
/// This will result in a [`Register::GroupedTable`](`crate::vm::Register::GroupedTable`) being stored at the `index` register.
///
/// Must be added before any projections so as to catch errors in column selections.
GroupBy { index: RegisterIndex, expr: Expr },
/// Order the [`Register::TableRef`](`crate::vm::Register::TableRef`) at `index` by the given expression.
///
/// This represents the `ORDER BY` clause in SQL.
Order {
index: RegisterIndex,
expr: Expr,
ascending: bool,
},
/// Truncate the [`Register::TableRef`](`crate::vm::Register::TableRef`) at `index` to the given number of rows.
///
/// This represents the `LIMIT` clause in SQL.
Limit { index: RegisterIndex, limit: u64 },
/// Return from register at `index`.
///
/// Some values stored in a register may be intermediate values and cannot be returned.
/// See [`Register`](`crate::vm::Register`) for more information.
Return { index: RegisterIndex },
/// Create a new schema.
///
/// This represents a `CREATE SCHEMA [IF NOT EXISTS]` statement.
NewSchema {
schema_name: SchemaRef,
/// If `true`, the schema is not created if it exists and no error is returned.
exists_ok: bool,
},
/// Start defining a new column and store the temporary metadata in register `index`.
///
/// The value stored in the register will be of type [`Register::Column`](`crate::vm::Register::Column`).
ColumnDef {
index: RegisterIndex,
/// The column name.
name: BoundedString,
data_type: DataType,
},
/// Add an option or constraint to the [`Column`](`crate::vm::Register::Column`) definition in register `index`.
AddColumnOption {
index: RegisterIndex,
option: ColumnOptionDef,
},
/// Add column in register `col_index` to the [`Register::TableRef`](`crate::vm::Register::TableRef`) in `table_reg_index`.
AddColumn {
table_reg_index: RegisterIndex,
col_index: RegisterIndex,
},
/// Create table from the [`Register::TableRef`](`crate::vm::Register::TableRef`) in register `index`.
///
/// Creation implies that the table is added to the schema.
///
/// This represents a `CREATE TABLE [IF NOT EXISTS]` statement.
NewTable {
index: RegisterIndex,
name: TableRef,
/// If `true`, the table is not created if it exists and no error is returned.
exists_ok: bool,
},
/// Drop the table referenced by the [`Register::TableRef`](`crate::vm::Register::TableRef`) in register `index`.
DropTable { index: RegisterIndex },
/// Remove the given column from the [`Register::TableRef`](`crate::vm::Register::TableRef`) in register `index`.
RemoveColumn {
index: RegisterIndex,
col_name: BoundedString,
},
/// Rename an existing column from the [`Register::TableRef`](`crate::vm::Register::TableRef`) in register `index`.
RenameColumn {
index: RegisterIndex,
old_name: BoundedString,
new_name: BoundedString,
},
/// Start a new insertion into the [`Register::TableRef`](`crate::vm::Register::TableRef`) in register `view_index`.
///
/// A [`Register::InsertDef`](`crate::vm::Register::InsertDef`) is stored in register `index`.
InsertDef {
table_reg_index: RegisterIndex,
index: RegisterIndex,
},
/// Add a column to the [`Register::InsertDef`](`crate::vm::Register::InsertDef`) in register `index`.
ColumnInsertDef {
insert_index: RegisterIndex,
col_name: BoundedString,
},
/// Start defining a new row of data to be inserted into the [`Register::InsertDef`](`crate::vm::Register::InsertDef`) in register `insert_index`.
///
/// The value stored in the register `index` will be of type [`Register::InsertRow`](`crate::vm::Register::InsertRow`).
RowDef {
insert_index: RegisterIndex,
row_index: RegisterIndex,
},
/// Add a value to the [`Register::InsertRow`](`crate::vm::Register::InsertRow`) in register `index`.
AddValue {
row_index: RegisterIndex,
expr: Expr,
},
/// Perform insertion defined in the [`Register::InsertRow`](`crate::vm::Register::InsertRow`) in register `index`.
///
/// This represents an `INSERT INTO` statement.
Insert { index: RegisterIndex },
/// Update values of the [`Register::TableRef`](`crate::vm::Register::TableRef`) in register `index`.
///
/// This represents an `UPDATE` statement.
Update {
index: RegisterIndex,
col: Expr,
expr: Expr,
},
/// Perform a union of the [`Register::TableRef`](`crate::vm::Register::TableRef`) in register `input1` and the [`Register::TableRef`](`crate::vm::Register::TableRef`) in register `input2`.
///
/// The output is stored as a [`Register::TableRef`](`crate::vm::Register::TableRef`) in register
/// `output`.
Union {
input1: RegisterIndex,
input2: RegisterIndex,
output: RegisterIndex,
},
/// Perform a cartesian join of the [`Register::TableRef`](`crate::vm::Register::TableRef`) in register `input1` and the [`Register::TableRef`](`crate::vm::Register::TableRef`) in register `input2`.
///
/// The output is stored as a [`Register::TableRef`](`crate::vm::Register::TableRef`) in register `output`.
CrossJoin {
input1: RegisterIndex,
input2: RegisterIndex,
output: RegisterIndex,
},
/// Perform a natural join of the [`Register::TableRef`](`crate::vm::Register::TableRef`) in register `input1` and the [`Register::TableRef](`crate::vm::Register::TableRef) in register `input2`.
///
/// The output is stored as a [`Register::TableRef`](`crate::vm::Register::TableRef`) in register `output`.
///
/// Note: this is both a left and a right join i.e., there will be `NULL`s where the common
/// columns do not match. The result must be filtered at a later stage.
NaturalJoin {
input1: RegisterIndex,
input2: RegisterIndex,
output: RegisterIndex,
},
}
// TODO: implement these features in the vm and use the SQL statements here to test them.
// #[cfg(test)]
// mod test {
// use sqlparser::ast::{ColumnOption, ColumnOptionDef, DataType};
// use crate::{
// expr::{BinOp, Expr, UnOp},
// table::TABLE_UNIQUE_KEY_NAME,
// value,
// vm::RegisterIndex,
// };
// use super::{Instruction::*, IntermediateCode};
// #[test]
// fn alter_statements() {
// // `ALTER TABLE table1 ADD COLUMN col4 STRING NULL`
// let table_reg_index = RegisterIndex::default();
// let col_index = table_reg_index.next_index();
// let _ = IntermediateCode {
// instrs: vec![
// Source {
// index: table_reg_index,
// name: "table1".into(),
// },
// ColumnDef {
// index: col_index,
// name: "col4".into(),
// data_type: DataType::String,
// },
// AddColumnOption {
// index: col_index,
// option: ColumnOptionDef {
// name: None,
// option: ColumnOption::Null,
// },
// },
// AddColumn {
// table_reg_index,
// col_index,
// },
// ],
// };
// // `ALTER TABLE table1 RENAME COLUMN col4 col5`
// let table_reg_index = RegisterIndex::default();
// let _ = IntermediateCode {
// instrs: vec![
// Source {
// index: table_reg_index,
// name: "table1".into(),
// },
// RenameColumn {
// index: table_reg_index,
// old_name: "col4".into(),
// new_name: "col5".into(),
// },
// ],
// };
// // `ALTER TABLE table1 DROP COLUMN col5`
// let table_reg_index = RegisterIndex::default();
// let _ = IntermediateCode {
// instrs: vec![
// Source {
// index: table_reg_index,
// name: "table1".into(),
// },
// RemoveColumn {
// index: table_reg_index,
// col_name: "col5".into(),
// },
// ],
// };
// }
// #[test]
// fn select_with_joins() {
// // `SELECT col1, col2, col5 FROM table1 INNER JOIN table2 ON table1.col2 = table2.col3`
// let table_reg_index = RegisterIndex::default();
// let table_reg_index_2 = table_reg_index.next_index();
// let table_reg_index_3 = table_reg_index_2.next_index();
// let table_reg_index_4 = table_reg_index_3.next_index();
// let _ = IntermediateCode {
// instrs: vec![
// Source {
// index: table_reg_index,
// name: "table1".into(),
// },
// Source {
// index: table_reg_index_2,
// name: "table2".into(),
// },
// CrossJoin {
// input1: table_reg_index,
// input2: table_reg_index_2,
// output: table_reg_index_3,
// },
// Filter {
// index: table_reg_index_3,
// expr: Expr::Binary {
// left: Box::new(Expr::ColumnRef("table1.col2".into())),
// op: BinOp::Equal,
// right: Box::new(Expr::ColumnRef("table2.col3".into())),
// },
// },
// // Inner join, so remove NULLs
// Filter {
// index: table_reg_index_3,
// expr: Expr::Unary {
// op: UnOp::IsNotNull,
// operand: Box::new(Expr::ColumnRef(
// format!("table1.{}", TABLE_UNIQUE_KEY_NAME).as_str().into(),
// )),
// },
// },
// // Inner join, so remove NULLs
// Filter {
// index: table_reg_index_3,
// expr: Expr::Unary {
// op: UnOp::IsNotNull,
// operand: Box::new(Expr::ColumnRef(
// format!("table2.{}", TABLE_UNIQUE_KEY_NAME).as_str().into(),
// )),
// },
// },
// Empty {
// index: table_reg_index_4,
// },
// Project {
// input: table_reg_index_3,
// output: table_reg_index_4,
// expr: Expr::ColumnRef("col1".into()),
// alias: None,
// },
// Project {
// input: table_reg_index_3,
// output: table_reg_index_4,
// expr: Expr::ColumnRef("col2".into()),
// alias: None,
// },
// Project {
// input: table_reg_index_3,
// output: table_reg_index_4,
// expr: Expr::ColumnRef("col5".into()),
// alias: None,
// },
// Return {
// index: table_reg_index_4,
// },
// ],
// };
// // `SELECT col1, col2, col5 FROM table1, table2`
// let table_reg_index = RegisterIndex::default();
// let table_reg_index_2 = table_reg_index.next_index();
// let table_reg_index_3 = table_reg_index_2.next_index();
// let table_reg_index_4 = table_reg_index_3.next_index();
// let _ = IntermediateCode {
// instrs: vec![
// Source {
// index: table_reg_index,
// name: "table1".into(),
// },
// Source {
// index: table_reg_index_2,
// name: "table2".into(),
// },
// CrossJoin {
// input1: table_reg_index,
// input2: table_reg_index_2,
// output: table_reg_index_3,
// },
// Empty {
// index: table_reg_index_4,
// },
// Project {
// input: table_reg_index_3,
// output: table_reg_index_4,
// expr: Expr::ColumnRef("col1".into()),
// alias: None,
// },
// Project {
// input: table_reg_index_3,
// output: table_reg_index_4,
// expr: Expr::ColumnRef("col2".into()),
// alias: None,
// },
// Project {
// input: table_reg_index_3,
// output: table_reg_index_4,
// expr: Expr::ColumnRef("col5".into()),
// alias: None,
// },
// Return {
// index: table_reg_index_4,
// },
// ],
// };
// // `SELECT col1, col2, col5 FROM table1 NATURAL JOIN table2`
// let table_reg_index = RegisterIndex::default();
// let table_reg_index_2 = table_reg_index.next_index();
// let table_reg_index_3 = table_reg_index_2.next_index();
// let table_reg_index_4 = table_reg_index_3.next_index();
// let _ = IntermediateCode {
// instrs: vec![
// Source {
// index: table_reg_index,
// name: "table1".into(),
// },
// Source {
// index: table_reg_index_2,
// name: "table2".into(),
// },
// NaturalJoin {
// input1: table_reg_index,
// input2: table_reg_index_2,
// output: table_reg_index_3,
// },
// // Not an outer join, so remove NULLs
// Filter {
// index: table_reg_index_3,
// expr: Expr::Unary {
// op: UnOp::IsNotNull,
// operand: Box::new(Expr::ColumnRef(
// format!("table1.{}", TABLE_UNIQUE_KEY_NAME).as_str().into(),
// )),
// },
// },
// // Not an outer join, so remove NULLs
// Filter {
// index: table_reg_index_3,
// expr: Expr::Unary {
// op: UnOp::IsNotNull,
// operand: Box::new(Expr::ColumnRef(
// format!("table2.{}", TABLE_UNIQUE_KEY_NAME).as_str().into(),
// )),
// },
// },
// Empty {
// index: table_reg_index_4,
// },
// Project {
// input: table_reg_index_3,
// output: table_reg_index_4,
// expr: Expr::ColumnRef("col1".into()),
// alias: None,
// },
// Project {
// input: table_reg_index_3,
// output: table_reg_index_4,
// expr: Expr::ColumnRef("col2".into()),
// alias: None,
// },
// Project {
// input: table_reg_index_3,
// output: table_reg_index_4,
// expr: Expr::ColumnRef("col5".into()),
// alias: None,
// },
// Return {
// index: table_reg_index_4,
// },
// ],
// };
// // `SELECT col1, col2, col5 FROM table1 LEFT OUTER JOIN table2 ON table1.col2 = table2.col3`
// let table_reg_index = RegisterIndex::default();
// let table_reg_index_2 = table_reg_index.next_index();
// let table_reg_index_3 = table_reg_index_2.next_index();
// let table_reg_index_4 = table_reg_index_3.next_index();
// let _ = IntermediateCode {
// instrs: vec![
// Source {
// index: table_reg_index,
// name: "table1".into(),
// },
// Source {
// index: table_reg_index_2,
// name: "table2".into(),
// },
// CrossJoin {
// input1: table_reg_index,
// input2: table_reg_index_2,
// output: table_reg_index_3,
// },
// Filter {
// index: table_reg_index_3,
// expr: Expr::Binary {
// left: Box::new(Expr::ColumnRef("table1.col2".into())),
// op: BinOp::Equal,
// right: Box::new(Expr::ColumnRef("table2.col3".into())),
// },
// },
// // Left outer join, so don't remove NULLs from first table
// // Left outer join, so remove NULLs from second table
// Filter {
// index: table_reg_index_3,
// expr: Expr::Unary {
// op: UnOp::IsNotNull,
// operand: Box::new(Expr::ColumnRef(
// format!("table2.{}", TABLE_UNIQUE_KEY_NAME).as_str().into(),
// )),
// },
// },
// Empty {
// index: table_reg_index_4,
// },
// Project {
// input: table_reg_index_3,
// output: table_reg_index_4,
// expr: Expr::ColumnRef("col1".into()),
// alias: None,
// },
// Project {
// input: table_reg_index_3,
// output: table_reg_index_4,
// expr: Expr::ColumnRef("col2".into()),
// alias: None,
// },
// Project {
// input: table_reg_index_3,
// output: table_reg_index_4,
// expr: Expr::ColumnRef("col5".into()),
// alias: None,
// },
// Return {
// index: table_reg_index_4,
// },
// ],
// };
// }
// #[test]
// fn update_statements() {
// // TODO
// // `UPDATE table1 SET col2 = 'bar' WHERE col1 = 1`
// // `UPDATE table1 SET col2 = 'bar' WHERE col1 = 1 AND col3 = 2`
// // `UPDATE table1 SET col2 = 'bar', col3 = 4 WHERE col1 = 1 AND col3 = 2`
// // `UPDATE table1 SET col2 = 'bar' WHERE col1 = 1 OR col3 = 2`
// // `UPDATE table1 SET col3 = col3 + 1 WHERE col2 = 'foo'`
// // `UPDATE table1, table2 SET table1.col3 = table1.col3 + 1 WHERE table2.col2 = 'foo'`
// }
// }