@qubu/adapter-pg
v0.8.0
Published
> Use an application-owned `pg` pool or connected client for PostgreSQL queries, EXPLAIN, and callback transactions.
Readme
@qubu/adapter-pg
Use an application-owned
pgpool or connected client for PostgreSQL queries, EXPLAIN, and callback transactions.
import { pgAdapter } from "@qubu/adapter-pg"
import { Pool } from "pg"
import { qubu } from "qubu"
const pool = new Pool({ connectionString: process.env.DATABASE_URL })
const db = qubu(pgAdapter(pool))
await db.transaction(async (transaction) => {
// Run related queries with transaction.execute(...).
})
// At application shutdown, after all work has finished:
await pool.end()Ordinary queries and EXPLAIN use the pool directly. Each transaction acquires
one client for BEGIN, callback queries, and COMMIT or ROLLBACK, then releases it.
Concurrent transactions and unrelated pool queries use separate connections.
A failed BEGIN or failed rollback discards the acquired client. Transaction and
cleanup failures are preserved together in an AggregateError. Qubu never
shuts down the application-owned pool.
Scoped clients support transaction() through savepoints on the same connection.
Catch an inner failure to continue the outer transaction; an uncaught failure
rolls back the outer transaction. Await every query and child scope. Finished
scopes and overlapping scopes reject; failed savepoint recovery prevents commit.
See nested transactions
for an example and lifecycle rules.
Limitations
- You can also pass a connected
Clientor an already-acquired pool client. The application owns its release and shutdown; Qubu never releases it. Root operations on the same adapter reject during a transaction; raw driver calls and other adapter instances must avoid that pinned client until it finishes. - No query streaming is exposed. Abort signals are checked before execution, but do not cancel an in-flight driver query.
- The
/migrationentry point requires an already-pinned client. It provides strict PostgreSQL catalog inspection by default;readSnapshotis an optional override. Migration locks supportnoneandexclusive, notshared.
See migration capability profiles for the execution requirements of migration entry points.
See PostgreSQL adoption for namespace selection, managed scope, connection ownership, and reviewed baseline commands.
