wasm-dbms

Documentation

Guides

Step-by-step guides for building databases with wasm-dbms:

Getting Started - Set up your first wasm-dbms database
CRUD Operations - Insert, select, update, and delete records
Querying - Filters, ordering, pagination, and field selection
Transactions - ACID transactions with commit/rollback
Relationships - Foreign keys, delete behaviors, and eager loading
Custom Data Types - Define your own data types (enums, structs)
Wasmtime Example - Using wasm-dbms with the WIT Component Model and Wasmtime

Reference

API and type reference documentation:

Data Types - All supported column types
Schema Definition - Table attributes and generated types
Validation - Built-in and custom validators
Sanitization - Built-in and custom sanitizers
JSON - JSON data type and filtering
Errors - Error types and handling

IC Integration

For deploying wasm-dbms as an Internet Computer canister:

IC Getting Started - Deploy a database canister on the IC
Access Control - Managing the ACL
Client API - Using the IC client library

Technical Documentation

For advanced users and contributors:

Architecture - Three-layer system overview
Memory Management - Stable memory internals
Join Engine - Cross-table join query internals

Quick Example

Define your schema:

use wasm_dbms_api::prelude::*;

#[derive(Debug, Table, Clone, PartialEq, Eq)]
#[table = "users"]
pub struct User {
    #[primary_key]
    pub id: Uint32,
    #[sanitizer(TrimSanitizer)]
    #[validate(MaxStrlenValidator(100))]
    pub name: Text,
    #[validate(EmailValidator)]
    pub email: Text,
}

Use the Database trait for CRUD operations:

use wasm_dbms_api::prelude::*;

// Insert
let user = UserInsertRequest {
    id: 1.into(),
    name: "Alice".into(),
    email: "[email protected]".into(),
};
database.insert::<User>(user)?;

// Query
let query = Query::builder()
    .filter(Filter::eq("name", Value::Text("Alice".into())))
    .build();
let users = database.select::<User>(query)?;

Features

Schema-driven: Define tables as Rust structs with derive macros
Runtime-agnostic: Works on any WASM runtime, not tied to a specific platform
CRUD operations: Full insert, select, update, delete support
ACID transactions: Commit/rollback with isolation
Foreign keys: Referential integrity with cascade/restrict behaviors
Validation & Sanitization: Built-in validators and sanitizers
JSON support: Store and query semi-structured data
IC Integration: First-class support for Internet Computer canisters via ic-dbms