Crate otter_sql

OtterSQL

🦦 An Embeddable SQL Executor in Rust

See README for more details.

This crate documentation describes the public API of OtterSQL. See above if you only want to use the CLI.

Installation

Add the following to your Cargo.toml

otter-sql = "0.1"

Getting started

use otter_sql::VirtualMachine;

fn main() {
    // initialize an OtterSQL VM
    let mut vm = VirtualMachine::default();

    // execute SQL!
    vm.execute(
        "
        CREATE TABLE table1
        (
            col1 INTEGER PRIMARY KEY NOT NULL,
            col2 STRING NOT NULL
        )
        ",
    ).unwrap();

    // insert some values
    vm.execute(
        "
        INSERT INTO table1 VALUES
            (2, 'bar'),
            (3, 'aaa')
        ",
    ).unwrap();

    // two unwraps because this returns a `Result<Option<Table>, ...>`.
    let res = vm.execute("SELECT * FROM table1").unwrap().unwrap();

    println!("{}", res);
}

Output:

╭──────┬──────╮
│ col1 │ col2 │
├──────┼──────┤
│ 2    │ bar  │
│ 3    │ aaa  │
╰──────┴──────╯

Re-exports

pub use column::Column;

pub use database::Database;

pub use ic::Instruction;

pub use ic::IntermediateCode;

pub use identifier::BoundedString;

pub use table::Table;

pub use value::Value;

pub use vm::VirtualMachine;

Modules

codegen

Intermediate code generation from the AST.

column

Columns in a table.

database

Databases.

expr

SQL expressions and their evaluation.

ic

Intermediate representation (IR) and instruction set for an SQL database.

identifier

Names used for tables, columns, schemas, DBs, etc.

parser

SQL parsing. A thin wrapper around sqlparser.

schema

Schemas (as in a namespace for tables, not a database schema).

table

Tables and rows.

value

Values contained in a table cell, its operations and errors.

vm

The executor virtual machine, its registers and errors.