rok-db-codegen 0.4.0

Generate a rok-db crate (models, typed queries and migrations) from .sql files
Documentation

rok-db-codegen

rok-db-gen turns .sql files into a Rust crate for rok-db:

  • models and enums from CREATE TABLE / CREATE TYPE;
  • typed async functions from sqlc-style annotated queries;
  • migrations computed from schema changes.
cargo install rok-db-codegen
rok-db-gen generate                        # db/*.sql -> db-gen/
rok-db-gen generate --migration add_slug   # after changing the schema
rok-db-gen check                           # CI: fail when db-gen/ is stale
-- db/user.sql
CREATE TABLE users (
    id    BIGSERIAL PRIMARY KEY,
    email TEXT NOT NULL UNIQUE,
    name  TEXT
);

-- name: find_by_email :one
SELECT * FROM users WHERE email = $1;

becomes db-gen/src/user.rs, with this usage:

db_gen::up(&db).await?;                                       // migrations
let user: Option<db_gen::user::User> = db_gen::user::find_by_email(&db, "ann@example.com").await?;
let named = db_gen::user::User::filter(db_gen::user::User::NAME.is_not_null()).all(&db).await?;

Query types are checked by PostgreSQL. Set DATABASE_URL when queries change: a temporary database is created and dropped, and the results are cached in db-gen/queries.json.

See the design and full reference and the example project.

License: MIT OR Apache-2.0.