Enum otter_sql::ic::Instruction

pub enum Instruction {
    Value {
        index: RegisterIndex,
        value: Value,
    },
    Expr {
        index: RegisterIndex,
        expr: Expr,
    },
    Source {
        index: RegisterIndex,
        name: TableRef,
    },
    Empty {
        index: RegisterIndex,
    },
    NonExistent {
        index: RegisterIndex,
    },
    Filter {
        index: RegisterIndex,
        expr: Expr,
    },
    Project {
        input: RegisterIndex,
        output: RegisterIndex,
        expr: Expr,
        alias: Option<BoundedString>,
    },
    GroupBy {
        index: RegisterIndex,
        expr: Expr,
    },
    Order {
        index: RegisterIndex,
        expr: Expr,
        ascending: bool,
    },
    Limit {
        index: RegisterIndex,
        limit: u64,
    },
    Return {
        index: RegisterIndex,
    },
    NewSchema {
        schema_name: SchemaRef,
        exists_ok: bool,
    },
    ColumnDef {
        index: RegisterIndex,
        name: BoundedString,
        data_type: DataType,
    },
    AddColumnOption {
        index: RegisterIndex,
        option: ColumnOptionDef,
    },
    AddColumn {
        table_reg_index: RegisterIndex,
        col_index: RegisterIndex,
    },
    NewTable {
        index: RegisterIndex,
        name: TableRef,
        exists_ok: bool,
    },
    DropTable {
        index: RegisterIndex,
    },
    RemoveColumn {
        index: RegisterIndex,
        col_name: BoundedString,
    },
    RenameColumn {
        index: RegisterIndex,
        old_name: BoundedString,
        new_name: BoundedString,
    },
    InsertDef {
        table_reg_index: RegisterIndex,
        index: RegisterIndex,
    },
    ColumnInsertDef {
        insert_index: RegisterIndex,
        col_name: BoundedString,
    },
    RowDef {
        insert_index: RegisterIndex,
        row_index: RegisterIndex,
    },
    AddValue {
        row_index: RegisterIndex,
        expr: Expr,
    },
    Insert {
        index: RegisterIndex,
    },
    Update {
        index: RegisterIndex,
        col: Expr,
        expr: Expr,
    },
    Union {
        input1: RegisterIndex,
        input2: RegisterIndex,
        output: RegisterIndex,
    },
    CrossJoin {
        input1: RegisterIndex,
        input2: RegisterIndex,
        output: RegisterIndex,
    },
    NaturalJoin {
        input1: RegisterIndex,
        input2: RegisterIndex,
        output: RegisterIndex,
    },
}

The instruction set of OtterSQL.

Variants

Value

Fields

index: RegisterIndex

value: Value

Load a Value into a register.

Expr

Fields

index: RegisterIndex

expr: Expr

Load a Expr into a register.

Source

Fields

index: RegisterIndex

name: TableRef

Load an existing table given by name.

This will result in a Register::TableRef being stored at the given register.

Empty

Fields

index: RegisterIndex

Create a new empty Register::TableRef.

NonExistent

Fields

index: RegisterIndex

Create a new [Register::TableRef](crate::vm::Register::TableRef) pointing to a non-existent table.

Filter

Fields

index: RegisterIndex

expr: Expr

Filter the Register::TableRef at index using the given expression.

This represents a WHERE clause of a SELECT statement in SQL.

Project

Fields

input: RegisterIndex

output: RegisterIndex

expr: Expr

alias: Option<BoundedString>

Create a projection of the columns of the Register::TableRef at input.

The resultant column is added to the 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.

GroupBy

Fields

index: RegisterIndex

expr: Expr

Group the Register::TableRef at index by the given expression.

This will result in a Register::GroupedTable being stored at the index register.

Must be added before any projections so as to catch errors in column selections.

Order

Fields

index: RegisterIndex

expr: Expr

ascending: bool

Order the Register::TableRef at index by the given expression.

This represents the ORDER BY clause in SQL.

Limit

Fields

index: RegisterIndex

limit: u64

Truncate the Register::TableRef at index to the given number of rows.

This represents the LIMIT clause in SQL.

Return

Fields

index: RegisterIndex

Return from register at index.

Some values stored in a register may be intermediate values and cannot be returned. See Register for more information.

NewSchema

Fields

schema_name: SchemaRef

exists_ok: bool

If true, the schema is not created if it exists and no error is returned.

Create a new schema.

This represents a CREATE SCHEMA [IF NOT EXISTS] statement.

ColumnDef

Fields

index: RegisterIndex

name: BoundedString

The column name.

data_type: DataType

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.

AddColumnOption

Fields

index: RegisterIndex

option: ColumnOptionDef

Add an option or constraint to the Column definition in register index.

AddColumn

Fields

table_reg_index: RegisterIndex

col_index: RegisterIndex

Add column in register col_index to the Register::TableRef in table_reg_index.

NewTable

Fields

index: RegisterIndex

name: TableRef

exists_ok: bool

If true, the table is not created if it exists and no error is returned.

Create table from the Register::TableRef in register index.

Creation implies that the table is added to the schema.

This represents a CREATE TABLE [IF NOT EXISTS] statement.

DropTable

Fields

index: RegisterIndex

Drop the table referenced by the Register::TableRef in register index.

RemoveColumn

Fields

index: RegisterIndex

col_name: BoundedString

Remove the given column from the Register::TableRef in register index.

RenameColumn

Fields

index: RegisterIndex

old_name: BoundedString

new_name: BoundedString

Rename an existing column from the Register::TableRef in register index.

InsertDef

Fields

table_reg_index: RegisterIndex

index: RegisterIndex

Start a new insertion into the Register::TableRef in register view_index.

A Register::InsertDef is stored in register index.

ColumnInsertDef

Fields

insert_index: RegisterIndex

col_name: BoundedString

Add a column to the Register::InsertDef in register index.

RowDef

Fields

insert_index: RegisterIndex

row_index: RegisterIndex

Start defining a new row of data to be inserted into the Register::InsertDef in register insert_index.

The value stored in the register index will be of type Register::InsertRow.

AddValue

Fields

row_index: RegisterIndex

expr: Expr

Add a value to the Register::InsertRow in register index.

Insert

Fields

index: RegisterIndex

Perform insertion defined in the Register::InsertRow in register index.

This represents an INSERT INTO statement.

Update

Fields

index: RegisterIndex

col: Expr

expr: Expr

Update values of the Register::TableRef in register index.

This represents an UPDATE statement.

Union

Fields

input1: RegisterIndex

input2: RegisterIndex

output: RegisterIndex

Perform a union of the Register::TableRef in register input1 and the Register::TableRef in register input2.

The output is stored as a Register::TableRef in register output.

CrossJoin

Fields

input1: RegisterIndex

input2: RegisterIndex

output: RegisterIndex

Perform a cartesian join of the Register::TableRef in register input1 and the Register::TableRef in register input2.

The output is stored as a Register::TableRef in register output.

NaturalJoin

Fields

input1: RegisterIndex

input2: RegisterIndex

output: RegisterIndex

Perform a natural join of the Register::TableRef in register input1 and the [Register::TableRef](crate::vm::Register::TableRef) in register input2.

The output is stored as a Register::TableRef in register output.

Note: this is both a left and a right join i.e., there will be NULLs where the common columns do not match. The result must be filtered at a later stage.

Trait Implementations

impl Clone for Instruction

fn clone(&self) -> Instruction

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Instruction

fn fmt(&self, fmt_derive_formatter_variable: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Instruction

fn fmt(&self, fmt_derive_formatter_variable: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<Instruction> for Instruction

fn eq(&self, other: &Instruction) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Instruction