Crate rustdb[][src]

Expand description

ToDo List:

Test cookies.

Make sys.Function a system table. Index sys.Schema.

Implement DROP INDEX, ALTER TABLE, fully implement CREATE INDEX.

Sort out error handling for PARSEINT etc.

Work on improving/testing SQL code, browse schema, float I/O.

Features

builtin exposes an interface that allows extra SQL builtin functions to be defined.

max exposes a maximal interface, including internal details.

Database with SQL-like language. Example program:

use rustdb::{pstore::SharedPagedData, stg::SimpleFileStorage, web::WebQuery, Database, init::INITSQL};
use std::net::TcpListener;
use std::sync::Arc;
   let sfs = Box::new(SimpleFileStorage::new(
       "c:\\Users\\pc\\rust\\sftest01.rustdb",
   ));
   let spd = Arc::new(SharedPagedData::new(sfs));
   let wstg = spd.open_write();
   let db = Database::new(wstg, INITSQL);
   let listener = TcpListener::bind("127.0.0.1:3000").unwrap();
   for tcps in listener.incoming() {
       let mut tcps = tcps.unwrap();
       let mut wq = WebQuery::new(&tcps); // Reads the http request from the TCP stream into wq.
       let sql = "EXEC web.Main()";
       db.run_timed(&sql, &mut wq); // Executes SQL, http response, SQL output, (status,headers,content) is accumulated in wq.
       wq.write(&mut tcps); // Write the http response to the TCP stream.
       db.save(); // Saves database changes to disk.
   }

See here for more advanced example (Axum webserver with ARGON hash function).

General Design of Database

SortedFile stores fixed size Records in a tree of Pages. SortedFile is used to implement:

(1) Variable length values ( which are split into fragments - see bytes module - although up to 15 bytes can be stored directly. ).

(2) Database Table storage. Each record has a 64-bit Id.

(3) Index storage ( an index record refers back to the main table ).

Pages have a maximum size, and are stored in CompactFile, which stores logical pages in smaller regions of backing storage.

When a page becomes too big, it is split into two pages.

Each page is implemented as a binary tree ( so there is a tree of trees ).

Re-exports

pub use crate::genquery::GenQuery;
pub use crate::genquery::Part;
pub use crate::init::INITSQL;
pub use crate::pstore::AccessPagedData;
pub use crate::pstore::SharedPagedData;
pub use crate::stg::SimpleFileStorage;
pub use crate::builtin::check_types;
pub use crate::compile::c_bool;
pub use crate::compile::c_float;
pub use crate::compile::c_int;
pub use crate::compile::c_value;
pub use crate::exec::EvalEnv;
pub use crate::expr::Block;
pub use crate::expr::DataKind;
pub use crate::expr::Expr;
pub use crate::run::CExp;
pub use crate::run::CExpPtr;
pub use crate::run::CompileFunc;
pub use crate::value::Value;

Modules

Compilation of builtin functions.

Storage of variable length values : ByteStorage.

Structs that implement CExp trait.

CompactFile : storage of logical pages in smaller regions of backing storage.

Functions to compile parsed expressions, checking types.

Instruction execution.

Expression types, result of parsing.

General Query.

Initial SQL

Page for SortedFile.

Parser.

Page storage.

Instruction and other run time types.

Sorted Record storage.

Backing storage for database.

System table functions.

Table, ColInfo, Row and other Table types.

Utility functions and macros.

Run-time Value.

WebQuery struct with http support.

Structs

Database with SQL-like interface.

Traits

Input/Output message. Query and response.

Type Definitions

Rc<Database>

Arc<Vec<u8>>