Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Frequently asked questions

What is ruprizzle-orm?

A schema-first ORM for Rust. You write a Prisma-style .ruprizzle schema, and the CLI generates typed entities, a Drizzle-style query builder, and migration SQL. It targets PostgreSQL, MySQL/MariaDB, and SQLite 3+.

Is it production-ready?

Yes, within the limits below. 1.5.1 (2026-09-13) was the first stable release and the public API is covered by semantic versioning from there on; the current release is 1.6.0 (2026-10-03). Earlier tags — v1.0.0, v1.0.1, v1.5.0 — are git tags whose publish runs failed before uploading anything; none of them exists on crates.io.

The design is complete and the test suite is broad, and the release gate ran green end-to-end for 1.5.1 and 1.6.0. Known gaps are still stated plainly in the release notes: the Turso and D1 adapters have opt-in live smoke tests that have not yet been run against the hosted services. See Known limitations for the deliberate boundaries before making it a mission-critical dependency.

Two gates were waived along the way, both in writing rather than by omission: the 48-hour rusqlite soak, accepted on 15.56 h / 1.46 B ops / 0 errors, and the two-week release-candidate feedback window, because the project had no external consumers to collect feedback from. See Stability for the semver policy, the waivers, and the public-dependency list (the 1.x line is pinned to sqlx 0.8).

The v1.1–v1.5 line (what's new) shipped inside 1.5.1, including Ruprizzle Studio and the Turso and D1 adapters. There is no Neon adapter: Neon is Postgres over TLS, so its connection string goes straight to ruprizzle::connect.

Which version should I install?

1.5.1 — the current stable release on crates.io.

[dependencies]
ruprizzle = "1.5"

If you are still on 1.0.0-rc.1, see Upgrading from 1.0.0-rc.1 to 1.5.1 — most applications need no code changes.

What databases does ruprizzle support?

PostgreSQL, MySQL/MariaDB and SQLite 3+, behind a DbDialect trait. Connections go through sqlx by default. Two native drivers are available as optional features: sqlite-rusqlite for synchronous SQLite, and an experimental postgres-tokio-postgres for PostgreSQL. Turso/libSQL and Cloudflare D1 adapters are published on crates.io (ruprizzle-turso, ruprizzle-d1), speaking their providers' HTTP APIs, but have not been validated against a live hosted database.

Is ruprizzle free? What licence is it under?

Yes — free and open source, dual-licensed MIT OR Apache-2.0, the standard arrangement in the Rust ecosystem. There is no paid tier, no telemetry and no commercial licence to buy.

How is it different from Diesel or SeaORM?

  • It is schema-first: the schema file is the single source of truth.
  • It generates a type-safe, token-based query builder where cross-model or wrong-typed filters are compile errors.
  • It supports nested include with per-relation filters in a bounded number of queries.
  • It diffs the schema to generate migrations automatically.
  • It exposes .to_sql() on every builder.

Which databases are supported?

PostgreSQL 17+, MySQL/MariaDB, and SQLite 3+ through SQLx. Native rusqlite and tokio-postgres drivers are available behind feature flags for better SQLite and PostgreSQL performance.

Does it require a query engine sidecar?

No. The runtime is a library built on sqlx. There is no separate process or hidden query engine binary.

Does it support compile-time query checking?

Yes. Use ruprizzle check --manifest <path> with a query manifest captured from tests or examples. See ADR-012 for the design.

Is there an LSP?

Yes. ruprizzle lsp (and the ruprizzle-lsp crate) provide completion, hover, formatting, diagnostics, and go-to-definition for schema.ruprizzle. A VS Code extension is in editor/.

How do I report bugs or request features?

Open an issue on the GitHub repository.