Quickstart

This page is the smallest generic setup path for trying CrateStack in a Rust service.

1. Include A Schema

Example schema:

auth Principal {
  id String
  role String?
}

mixin AuditFields {
  createdAt DateTime @default(dbgenerated())
  updatedAt DateTime @default(dbgenerated())
}

model Post {
  @use(AuditFields)

  id String @id
  title String

  @@allow("read", auth() != null)
}

Pick the macro that matches the crate’s role:

// Server crate
use cratestack::include_server_schema;

include_server_schema!("schema.cstack", db = Postgres);

The db = Postgres argument is required today (the only accepted value). The parser is wired so future db = MySql / db = Sqlite support is non-breaking at call sites that already pass Postgres. Embedded (mobile / desktop / browser-via-OPFS) and HTTP-client crates use different macros — see Offline-First Embedded SQLite and the client-runtime docs respectively.

2. Build The Generated Runtime

let pool = sqlx::PgPool::connect(&std::env::var("DATABASE_URL")?).await?;
let cool = cratestack_schema::CrateStack::builder(pool).build();

3. Use Delegates Directly

You can use CrateStack without mounting the generated REST layer.

let visible_posts = cool
    .post()
    .find_many()
    .where_expr(
        cratestack_schema::post::author()
            .email()
            .eq("owner@example.com")
            .and(cratestack_schema::post::published().is_true()),
    )
    .order_by(cratestack_schema::post::author().email().desc())
    .limit(20)
    .run(&ctx)
    .await?;

4. Optionally Bind Auth For Internal Callers

let bound = cool.bind_auth(Some(serde_json::json!({
    "id": 7,
    "role": "admin"
})))?;

let posts = bound.post().find_many().run().await?;

5. Optionally Mount Generated Routers

let app = axum::Router::new().nest(
    "/api",
    cratestack_schema::axum::model_router(
        cool.clone(),
        cratestack_codec_cbor::CborCodec,
        AppAuthProvider,
    ),
);

​Quickstart

​1. Include A Schema

​2. Build The Generated Runtime

​3. Use Delegates Directly

​4. Optionally Bind Auth For Internal Callers

​5. Optionally Mount Generated Routers

​Read Next