orm

tinywasm/orm

Ultra-lightweight, strongly-typed ORM engineered for WebAssembly and backend environments.

Features

• Zero Reflection: Interface-driven schema via github.com/tinywasm/fmt
• Isomorphic: Same generated code works in Go (backend) and WASM (frontend)
• Three Layers: DB persistence, JSON transport, and Form UI — from one struct definition
• Code Generator: ormc CLI generates boilerplate from struct tags

Installation

go get github.com/tinywasm/orm
go install github.com/tinywasm/orm/cmd/ormc@latest

Three Layers, One Struct

ormc generates code for three layers depending on the directive and tags present:

Directives

Quick Start

1. Define your structs

package user

// ormc:form — DB + Form: full CRUD with UI rendering
type User struct {
    ID      string
    Name    string
    Email   string `db:"unique" input:"email"`
    Bio     string `json:",omitempty" input:"textarea"`
    Address Address
}

// ormc:formonly — Form only: validation + UI, no DB
type Address struct {
    Street string
    City   string
    Zip    string `input:"number"`
}

ormc auto-detects: ID as PK, field names as column/JSON names, default input.Text() widget for string fields. Only add tags when overriding defaults.

2. Generate

ormc

Generates model_orm.go next to each source file.

[!TIP] ormc automatically runs go get for required dependencies and go mod tidy if a go.mod is detected.

3. Use it

func GetActiveUsers(db *orm.DB) (*user.UserList, error) {
    return user.ReadAllUser(
        db.Query(&user.User{}).
            Where(user.User_.Email).Like("%@gmail.com").
            Limit(10),
    )
}

Tags Reference

db: — DB layer

DB flags are grouped in Field.DB *FieldDB (nil for formonly structs). Helpers: field.IsPK(), field.IsUnique(), field.IsAutoInc().

String PKs: must be set by caller via github.com/tinywasm/unixid before db.Create(). The ORM does not generate IDs.

json: — JSON layer

Raw option usage:

input: — Form layer

Available widget types: text, email, password, textarea, phone, number, date, hour, ip, rut, address, checkbox, datalist, select, radio, filepath, gender.

ormc generates Validate(action byte) calling fmt.ValidateFields(action, m). Validation runs for 'c' (create), 'u' (update), and 'd' (delete, PK only).

Schema Types

API Reference

DB Operations

db := orm.New(executor, compiler)

db.Create(&user)
db.Update(&user, orm.Eq(User_.ID, user.ID))
db.Delete(&user, orm.Eq(User_.ID, user.ID))
db.CreateTable(&User{})
db.DropTable(&User{})

Update and Delete require at least one condition (compile-time enforced):

db.Update(&res, orm.Eq(Reservation_.ID, res.ID))  // one condition
db.Update(&cfg, orm.Eq(Config_.TenantID, tid),     // multiple conditions
                orm.Eq(Config_.Key, key))
db.Update(&res)                                     // compile error

Query Builder

user.ReadAllUser(
    db.Query(&user.User{}).
        Where(user.User_.Email).Like("%@example.com").
        OrderBy(user.User_.Name).Asc().
        Limit(10).Offset(20),
)

Chainable: Where(col) → .Eq(), .Neq(), .Gt(), .Gte(), .Lt(), .Lte(), .Like(), .In() | OrderBy(col) → .Asc(), .Desc() | Limit(n), Offset(n), GroupBy(cols...)

Interfaces

ormc — Code Generation

Run from the project root. Scans subdirectories for model.go / models.go:

project/
  modules/
    user/model.go      → modules/user/model_orm.go
    product/models.go  → modules/product/model_orm.go

//go:generate ormc

Generated per struct:

Programmatic API:

More Documentation

• Architecture