spg-sqlx
sqlx 0.8 Database driver for [spg-embedded]. Lets
in-process callers swap sqlx::PgPool for SpgPool and keep
the rest of their sqlx::query / sqlx::query_as /
pool.begin cement unchanged — backs mailrs's drop-in
"PgPool → SpgPool" goal from the gap evaluation (E1).
v7.16.0 MVP scope
- [
Spg] marker type + the 11 associated typessqlx::Databaserequires, all wired up to compile. - [
SpgPool] / [SpgConnection] wrap [spg_embedded_tokio::AsyncDatabase] so a single in-process database is the "pool". No real pooling — every "connection" handle is a cheap clone of the underlyingArc<Mutex<Database>>. - Bind-time [
Value][SpgValue] encoding for the basic scalar surface:i32,i64,bool,String,Vec<u8>. Round-trip verified end-to-end againstsqlx::query("INSERT …").bind(…)in the test suite. - Transactions via the engine's BEGIN/COMMIT/ROLLBACK; the
[
SpgTransactionManager] wraps that forpool.begin().
v7.16.x / v7.17 follow-up
- Encode/Decode for the remaining mailrs-side types:
TIMESTAMPTZ (
chrono::DateTime<Utc>), JSON / JSONB (serde_json::Value),tsvector,VECTOR(N),INT[]/TEXT[],BYTEA(Vec beyond the basic path), numeric. FromRowderive support — the macro's generated impl reads columns by index/name via the [Row][sqlx_core::row::Row] trait, so wiringSpgRow::try_getis enough for the derive to "just work" once the per-type Decode lands.sqlx::query!()compile-time validation via sqlx's offline mode (SQLX_OFFLINE=true+ a checked-in.sqlx/dir). The adapter itself doesn't need a DESCRIBE protocol —Spg-shaped offline cache mirrors what mailrs ships against PG today.
Quick start
use spg_sqlx::{SpgPool, SpgPoolExt};
# async fn _f() -> Result<(), Box<dyn std::error::Error>> {
let pool = SpgPool::connect_in_memory().await?;
sqlx::query("CREATE TABLE users (id INT NOT NULL, name TEXT NOT NULL)")
.execute(&pool)
.await?;
sqlx::query("INSERT INTO users VALUES ($1, $2)")
.bind(1_i32)
.bind("alice")
.execute(&pool)
.await?;
# Ok(())
# }
Concurrency, durability, and Send + Sync (mailrs round-9 B.4)
SpgPool: Send + Sync + 'static
[SpgPool] is Pool<Spg> from sqlx-core, which is
Send + Sync + 'static by construction. Holding it inside
Arc<WebState> for sharing across Axum/Tower handlers,
background workers, and long-lived spawn tasks works the
same as sqlx::PgPool. Clones are cheap (Arc bumps).
Single-process write semantics
Every connection acquired from one [SpgPool] shares the
same underlying [spg_embedded_tokio::AsyncDatabase] (one
Arc<Mutex<Database>> behind a tokio::sync::OnceCell on
[SpgConnectOptions]). That's how
let mut tx = pool.begin().await?; and a separate
pool.acquire().await? see the same committed state.
The single-writer invariant of the underlying spg-engine is
upheld by the tokio::sync::Mutex inside AsyncDatabase:
every execute/query serialises against every other call
on the same pool, and tx.commit().await? is what makes
the in-tx writes visible to subsequent reads.
Cross-process write semantics
Two coexisting processes opening the same open_path(p)
are NOT serialised by SPG. SPG-embedded is single-writer
at the process level: each process gets its own
Arc<Mutex<Database>>, and the WAL on disk is not
flock-coordinated across them. If a second process opens
the path while the first is running:
- the second process replays the WAL as of its open moment and sees a snapshot of state through the last completed checkpoint + the WAL it read,
- subsequent writes from the second process land in its own in-memory catalog and its own WAL append,
- whichever process flushes last wins for the catalog snapshot on the next checkpoint, and the other process's writes are silently lost on reopen.
For an admin-tool + server use case (mailrs round-9 B.4 question 1), the safe pattern is to STOP the server, run the admin tool, then START the server. The cross-process locking story (file lock, lease, advisory lock) is a v7.17+ ask; today the contract is "single-process owner per database file."
WAL durability under crash
[spg_embedded::Database::execute] fsyncs the WAL append
before returning Ok. So at the moment a successful
execute() returns, the write is durable across a process
crash AND a host power loss. On reopen,
[spg_embedded::Database::open_path] replays every
WAL record produced since the last checkpoint — the
ZERO-CHANGE CUTOVER VERIFIED gate (mailrs-spg-embedded
validation harness) covers this end to end.
What's NOT durable:
- A
BEGIN-but-not-yet-COMMITtransaction at crash time rolls back on reopen — the in-tx WAL records aren't replayed. This is the desired behaviour: SPG's transaction model is single-writer with explicit COMMIT. - The catalog snapshot file (the periodic checkpoint output) is rewritten atomically via temp-file + rename; a crash during checkpoint leaves the previous snapshot intact.
The checkpoint threshold defaults to 4 MiB of WAL growth and
is configurable via
[spg_embedded::Database::set_checkpoint_threshold_bytes].
Lower thresholds make recovery faster (less WAL to replay)
at the cost of more frequent IO; higher thresholds amortise
IO but extend recovery time.