GlueSQL

SQL Database Engine as a Library

GlueSQL is a SQL database library written in Rust.
It provides a parser (sqlparser-rs), execution layer, and optional storages (sled or memory) packaged into a single library.
Developers can choose to use GlueSQL to build their own SQL database, or as an embedded SQL database using the default storage engine.

Standalone Mode

You can use GlueSQL as an embedded SQL database.
GlueSQL provides three reference storage options.

• SledStorage - Persistent storage engine based on sled
• MemoryStorage - Non-persistent storage engine based on BTreeMap
• SharedMemoryStorage - Non-persistent storage engine which works in multi-threaded environment

Installation

• Cargo.toml

toml [dependencies] gluesql = "0.13"

• CLI application

$ cargo install gluesql

Usage

```rust use gluesql::prelude::*;

fn main() { let storage = SledStorage::new("data/doc-db").unwrap(); let mut glue = Glue::new(storage); let sqls = vec![ "DROP TABLE IF EXISTS Glue;", "CREATE TABLE Glue (id INTEGER);", "INSERT INTO Glue VALUES (100);", "INSERT INTO Glue VALUES (200);", "SELECT * FROM Glue WHERE id > 100;", ];

for sql in sqls {
    let output = glue.execute(sql).unwrap();
    println!("{:?}", output)
}

} ```

SQL Library Mode (For Custom Storage)

Installation

sled-storage and memory-storage features are optional, so these are not required for custom storage makers.

toml [dependencies.gluesql] version = "0.13" default-features = false features = ["alter-table", "index", "transaction"]

Four features below are also optional

• alter-table - ALTER TABLE query support
• index - CREATE INDEX and DROP INDEX, index support
• transaction - BEGIN, ROLLBACK and COMMIT, transaction support

Usage

Two mandatory store traits to implement

• Store & StoreMut

```rust pub trait Store { async fn fetchschema(..) -> ..; async fn fetchdata(..) -> ..; async fn scan_data(..) -> ..; }

pub trait StoreMut where Self: Sized { async fn insertschema(..) -> ..; async fn deleteschema(..) -> ..; async fn appenddata(..) -> ..; async fn insertdata(..) -> ..; async fn delete_data(..) -> ..; } ```

Optional store traits

• AlterTable, Index & IndexMut, Transaction

```rust pub trait AlterTable where Self: Sized { async fn renameschema(..) -> ..; async fn renamecolumn(..) -> ..; async fn addcolumn(..) -> ..; async fn dropcolumn(..) -> ..; }

pub trait Index { async fn scanindexeddata(..) -> ..; }

pub trait IndexMut where Self: Sized { async fn createindex(..) -> ..; async fn dropindex(..) -> ..; }

pub trait Transaction where Self: Sized { async fn begin(..) -> ..; async fn rollback(..) -> ..; async fn commit(..) -> ..; } ```

GlueSQL.js

GlueSQL.js is a SQL database for web browsers and Node.js. It works as an embedded database and entirely runs in the browser. GlueSQL.js supports in-memory storage backend, but it will soon to have localStorage, sessionStorage and indexedDB backend supports.

More info

• GlueSQL for web browsers and Node.js

SQL Features

GlueSQL currently supports a limited subset of queries. It's being actively developed.

Data Types

| Category | Type | | -------- | -------------------------------------------------------------------------- | | Numeric | INT8, INT16, INT32, INTEGER, INT128, UINT8, FLOAT, DECIMAL | | Date | DATE, TIME, TIMESTAMP, INTERVAL | | Others | BOOLEAN, TEXT, UUID, MAP, LIST, BYTEA |

Queries

• CREATE TABLE, DROP TABLE
• ALTER TABLE - ADD COLUMN, DROP COLUMN, RENAME COLUMN and RENAME TO.
• CREATE INDEX, DROP INDEX
• INSERT, UPDATE, DELETE, SELECT
• GROUP BY, HAVING
• ORDER BY
• Transaction queries: BEGIN, ROLLBACK and COMMIT
• Nested select, join, aggregations ...

You can see tests for the currently supported queries in test-suite/src/*.