peque ~master

Peque — PostgreSQL client for D

Peque is a PostgreSQL client for the D programming language: a lightweight libpq wrapper, plus optional subpackages providing a compile-time ORM, a migration runner and vibe.d integration.

It uses SafeRefCounted (from std.typecons) to manage libpq objects deterministically — connections and results are freed as soon as they go out of scope, without depending on the GC. The ORM and migration layers are separate subpackages, so a project that only wants the binding pays nothing for them.

Features

• Reference-counted Connection and Result — deterministic cleanup, no GC dependency
• Parameterized queries via execParams — SQL injection safe by design
• Automatic bidirectional type conversion between PostgreSQL text format and D types
• Nullable!T support for NULL columns
• RAII transaction helper with auto-commit / auto-rollback on exception
• Configurable transaction isolation level (readCommitted, repeatableRead, serializable, serverDefault)
• Savepoint support for partial rollbacks within a transaction
• Static or dynamic (bindbc-loader) loading of libpq
• `peque:orm` — compile-time ORM with type-safe WHERE predicates, QuerySet, and schema generation
• `peque:migrate` — compile-time D-struct migration runner with rollback and opt-in checksum pinning
• `peque:vibe` — vibe.d fiber-aware integration (VibeWaitStrategy + VibeConnectionPool)

Status of the subpackages

peque:orm and peque:migrate are experimental. They are used and tested, but their APIs are still moving: expect breaking changes on a minor version bump, not only a major one. Pin an exact version if that matters to you. The core package (Connection, Result, the converters, the pool) is stable by comparison — breaking changes there are rare and called out in the changelog.

The peque:orm, peque:migrate and peque:vibe subpackages were implemented with heavy use of AI coding assistants running in an autonomous mode. Every change is covered by the test suite described in Running tests and reviewed before merging, but the volume of generated code is large, so treat these subpackages with the scrutiny you would give any young dependency.

Supported types

D type	PostgreSQL type
string	text, varchar, char, …
JSONValue	json, jsonb
int, long, short	integer, bigint, smallint
float, double	real, double precision (incl. NaN, Infinity, -Infinity)
bool	boolean
UUID	uuid
Date	date
DateTime	timestamp
SysTime	timestamptz
T[]	one-dimensional arrays
Nullable!T	any nullable column

Time zones

SysTime is an instant; DateTime is a wall clock. Which one you pick decides whether the value survives a change of server, and the two are not interchangeable.

A SysTime is normalised to UTC on the way out, so what you write means the same thing whatever the server's session TimeZone is set to. This matters more than it sounds: SysTime.toString omits the UTC offset for values in LocalTime() — what Clock.currTime returns — so without the normalisation PostgreSQL would read a naked wall clock and apply its own session zone.

partner.createdAt = Clock.currTime;   // stored as the instant it names

Reading a timestamptz into a DateTime is refused with a ConversionError: DateTime has nowhere to keep the offset, so the value would silently become whatever wall clock the server's TimeZone renders — a different answer on a different server. Use SysTime, or string for the raw text.

Pinning the session zone

Nothing above depends on the server's TimeZone — that is the point of the normalisation. What does depend on it is anything PostgreSQL renders: now()::text, to_char, a timestamptz cast to text in a raw query. That setting comes from the server's configuration or the client's PGTZ, so the same code can print different times on two machines. Pin it at connect:

auto c = Connection(
    dbname: "mydb", user: "myuser", password: "secret",
    host: "localhost", port: "5432",
    timezone: "UTC",              // applied once, on connect
);

Every constructor takes it, as a separate argument that sits between the connection parameters and the wait strategy — connection parameters go to libpq untouched, and timezone is peque's setting, not libpq's:

auto c = Connection(params, "UTC");              // string[string] params
auto c = Connection(connStr, "UTC");             // conninfo string
auto pool = makeVibePool(8, params, "UTC");      // every connection in the pool
auto c = connectViaEnvParams(defaults, "UTC");

An unknown zone fails the connection rather than leaving one whose rendering quietly differs from what you asked for.

Deliberately connect-time only: a pooled connection keeps its session state across borrows, so setting the zone per request would leak one request's zone into whoever borrows that connection next. For a per-user zone, convert at the edges or say AT TIME ZONE $1 in the query.

Two libpq mechanisms do the same job from outside the code, and work with peque without any of the above: the `PGTZ` environment variable, and libpq's options connection keyword (options=-c timezone=UTC). Both travel in the startup packet — pg_settings.source reads client rather than session — so they are useful for pinning a zone you do not want to hard-code. timezone is not a libpq keyword itself; passing one to libpq is an "invalid connection option" error, which is why peque strips its own key before connecting.

Reading values back

Values always come back in UTC, whatever offset the server rendered — one rule, so two rows of a result set cannot print in different zones. The instant is what peque guarantees; to display one, convert explicitly:

auto ts = row["created_at"].get!SysTime;
ts.toUTC;                                              // canonical form
ts.toOtherTZ(PosixTimeZone.getTimeZone("Europe/Kyiv"));  // for display

For an application serving users in several zones: store instants as timestamptz/SysTime, keep each user's zone as an IANA name ("Europe/Kyiv", not "+03:00" — offsets change with DST), and convert only when rendering. Grouping by a user's local day belongs in SQL, where the zone database does the work — including the DST transitions that make a local day 23 or 25 hours long. groupByRaw! takes an expression as a group key:

@autoHydrate
struct DayCount { DateTime localDay; long n; }

auto rows = repo.query()
    .where!"userId"(userId)
    .groupByRaw!("localDay",
                 `date_trunc('day', _m.created_at AT TIME ZONE 'Europe/Kyiv')`)
    .annotate!("n", "COUNT(*)")
    .orderBy("local_day")
    .select!DayCount();

Use a named zone rather than a bare offset: AT TIME ZONE '-05:00' follows POSIX sign conventions and shifts the opposite way from what the string suggests, while 'America/New_York' applies the real rules for that date.

A groupByRaw! expression is embedded verbatim and cannot carry bound parameters, so it must be a trusted literal. When the zone itself is a runtime value — each user's own — bind it through execParams instead of building the SQL by concatenation:

auto rows = c.execParams(`
    SELECT date_trunc('day', created_at AT TIME ZONE $1) AS local_day,
           count(*)                                      AS n
      FROM visits
     WHERE user_id = $2
     GROUP BY 1 ORDER BY 1`, userTz, userId).as!(DayCount[]);

Two things timestamp (without a zone) is still right for: a future local event — "09:00 in Kyiv on 2027-03-15" must keep its wall clock plus a zone name, because the zone's rules may change before then and a precomputed instant would silently become the wrong local time — and values that are not instants at all, such as a business date, which belongs in Date.

Installation

dub.json:

"dependencies": {
    "peque": "~>0.2.0"
}

dub.sdl:

dependency "peque" version="~>0.2.0"

Sub-packages are opt-in. Note that peque:orm and peque:migrate are not part of any tagged release yet — they land in the next one; until then depend on the repository directly if you want them:

dependency "peque:orm"     version="~>0.2.0"   // ORM layer
dependency "peque:migrate" version="~>0.2.0"   // migration runner
dependency "peque:vibe"    version="~>0.2.0"   // vibe.d integration

Choose a configuration depending on how you want to link libpq:

Configuration	Description
libraryStatic	Static library — links libpq directly
libraryDynamic	Dynamic library — loads libpq at runtime via bindbc-loader

Quick start

import peque;
import std.stdio;

auto c = Connection(
    dbname: "mydb",
    user:   "myuser",
    password: "secret",
    host:   "localhost",
    port:   "5432",
);

// Raw SQL — fine for DDL or trusted input
c.exec("
    CREATE TABLE IF NOT EXISTS items (id serial, name text, qty int);
    INSERT INTO items (name, qty) VALUES ('apple', 5), ('banana', 3);
");

// Parameterized query — SQL-injection safe
auto res = c.execParams(
    "SELECT name, qty FROM items WHERE qty > $1", 2);

foreach (row; res)
    writeln(row["name"].get!string, ": ", row["qty"].get!int);

// Nullable column
auto maybeQty = res[0]["qty"].get!(Nullable!int);
if (!maybeQty.isNull)
    writeln(maybeQty.get);

Prepared statements

Connection.prepare() registers a server-side prepared statement and returns a move-only PreparedStatement handle. Its destructor issues DEALLOCATE automatically when it goes out of scope.

auto stmt = conn.prepare("find_user",
    "SELECT id, name FROM users WHERE id = $1");

auto result = stmt.exec(42);
// stmt goes out of scope → DEALLOCATE find_user sent automatically

Useful when the same query runs many times in the same connection session — the server parses and plans it once.

Transactions

Connection.transaction() runs a delegate inside a BEGIN/COMMIT block. On exception the transaction is always rolled back. The delegate receives a ref Transaction handle that exposes exec, execParams, and escapeString but intentionally hides commit() and rollback() — making accidental early termination of the transaction a compile-time error rather than a silent runtime bug.

c.transaction((ref tx) {
    tx.execParams("INSERT INTO items (name, qty) VALUES ($1, $2)", "cherry", 10);
    tx.execParams("UPDATE items SET qty = qty - 1 WHERE name = $1", "apple");
});

transaction() can return a value:

auto newQty = c.transaction((ref tx) {
    tx.execParams("UPDATE items SET qty = qty - 1 WHERE name = $1", "apple");
    return tx.execParams(
        "SELECT qty FROM items WHERE name = $1", "apple")[0][0].get!int;
});

Use OnSuccess.rollback for dry-runs or test helpers that must not persist changes:

c.transaction!(OnSuccess.rollback)((ref tx) {
    tx.execParams("DELETE FROM items");
    auto count = tx.execParams("SELECT count(*) FROM items")[0][0].get!long;
    assert(count == 0);
    // transaction is rolled back after the delegate returns
});

Savepoints

Transaction.savepoint() creates a PostgreSQL savepoint. On exception, only the savepoint changes are rolled back — the enclosing transaction remains open and intact.

c.transaction((ref tx) {
    tx.execParams("INSERT INTO items (name, qty) VALUES ($1, $2)", "date", 7);

    try {
        tx.savepoint((ref tx) {
            tx.execParams(
                "INSERT INTO items (name, qty) VALUES ($1, $2)", "elderberry", 2);
            throw new Exception("changed my mind");
            // only the elderberry insert is rolled back
        });
    } catch (Exception e) {}

    // date is still in the transaction and will be committed
});

Isolation levels

// Read committed (default)
c.transaction((ref tx) { ... });

// Repeatable read
c.transaction!(OnSuccess.commit, IsolationLevel.repeatableRead)((ref tx) { ... });

// Serializable — may abort; application must be prepared to retry
c.transaction!(OnSuccess.commit, IsolationLevel.serializable)((ref tx) { ... });

// Server default — defers to postgresql.conf / ALTER ROLE / ALTER DATABASE
c.transaction!(OnSuccess.commit, IsolationLevel.serverDefault)((ref tx) { ... });

ORM (peque:orm)

Experimental. The API is still moving — expect breaking changes on a minor version bump. Implemented with heavy use of AI coding assistants in autonomous mode; see Status of the subpackages.

peque:orm is a compile-time ORM that generates SQL from model UDA metadata. Nothing is reflected at runtime — all column names, table names, and SELECT lists are computed by the compiler.

Model definition

import peque.orm;

@model("res_partner")
struct Partner {
    @primaryKey int    id;
    @field      string name;
    @field      string email;
    @field      bool   active;
}

A bare @field maps the member to its snake_case column: createdAt is the column created_at. Runs of capitals stay whole, so myURL is my_url, not my_u_r_l. Name the column explicitly whenever the conversion is not what you want — that is also how you address a legacy or mixed-case schema:

@model("res_partner")
struct Partner {
    @primaryKey          int     id;
    @field               string  name;        // -> name
    @field               SysTime createdAt;   // -> created_at
    @field("XMLPayload") string  payload;     // -> XMLPayload, exactly
}

Table names are never derived — @model always takes the name, so renaming a D struct cannot silently rename a table.

Column constraints and indexes

@model("products")
@uniqueTogether!("name", "tenantId")
@checkConstraint("chk_price", "price > 0")
@indexTogether!("categoryId", "active")
@uniqueIndexTogether!("tenantId", "slug")
struct Product {
    @primaryKey                                int    id;
    @field @unique @index                      string sku;
    @field @check("price > 0")                 double price;
    @field @pgDefault("true")                  bool   active;
    @field @pgDefault("0") @pgNotNull          Nullable!int stock;
    @field @pgType("NUMERIC(10,2)")            double cost;
    @field @uniqueIndex                        string slug;
    @field @uniqueIndex(where: "active = true") string externalId;
    @field @ginIndex                           JSONValue metadata;
    @field @hashIndex                          string sessionToken;
    @field @gistIndex                          string location;
}

Index name convention (all checked against PostgreSQL's 63-byte limit at compile time):

UDA	Prefix	Method
@index	idx_	btree (default, no USING)
@uniqueIndex	uniq_	btree
@ginIndex	gin_	USING gin
@gistIndex	gist_	USING gist
@hashIndex	hash_	USING hash
@indexTogether	idx_	btree
@uniqueIndexTogether	uniq_	btree

Which name goes where

Anywhere peque names a model member, it takes the D field name — where!, orderBy!, groupBy!, set!, load!, prefetch!, F!(M, "field"), upsert!, Target.columns!, @one2many!(Line, "orderId"), @defaultOrder, and the column lists of @uniqueTogether! / @indexTogether! / @uniqueIndexTogether!. Those are resolved to columns, so the emitted SQL and the generated index names are unaffected by the spelling.

SQL names appear only where no D name exists:

• raw SQL expressions — @check, @pgDefault, @checkConstraint, and the where: predicate on the index UDAs;
• names of database objects — @model("table"), @field("col"), @pgType("…"), an index's name:;
• the junction table and its key columns in @many2many, which belong to a table that is not a model.

Reaching for the wrong spelling is a compile error that names the mistake and suggests the other one.

The boundary is sharp, and a single declaration can sit on both sides of it — the column list is D, the predicate is SQL:

@(indexTogether!("queue", "runAt")(where: "state = 'pending'"))
//                        ^^^^^ D field          ^^^^^ SQL column

runAt is a member peque resolves to run_at; state is inside an expression peque passes to PostgreSQL untouched, so it has to be the column. The rule answers it every time: peque resolves names of your model, and only what has no D name stays SQL.

Fields named after D keywords

A column may be named version, default, module or any other D keyword, which no member can be. Name the member with a trailing underscore and give @field the real column:

@model("release")
struct Release {
    @primaryKey       int    id;
    @field("version") int    version_;   // column "version"
    @field("default") string default_;   // column "default"
}

The D-side spelling stays version_ everywhere — where!"version_"(7), orderBy!("version_"), the struct member itself — and only the emitted SQL says version. The underscore is a D convention, not a peque one: camelToSnake keeps it, so without the explicit @field the column would be version_ too.

Identifier quoting

Every identifier peque emits — table, column, junction table and its keys, constraint names — is double-quoted in the generated SQL. That means a field called order, end, user or check just works, with no keyword list to fall out of date as PostgreSQL reserves new words:

@model("order")                       // reserved word, fine
struct Order {
    @primaryKey int    id;
    @field      string check;         // reserved word, fine
    @field      int    end;           // reserved word, fine
}
// CREATE TABLE IF NOT EXISTS "order" ("id" SERIAL PRIMARY KEY, "check" TEXT …)

The consequence to know: quoted identifiers are case-exact, so the string you write in @model/@field is the identifier. Converted names are all lowercase, so quoting them changes nothing. It matters when mapping a table you did not create:

-- Written by someone else, unquoted, so PostgreSQL folded it to lowercase:
CREATE TABLE SaleOrder (OrderDate date);   -- actually stored as saleorder / orderdate

@model("saleorder")                        // the folded name, not "SaleOrder"
struct SaleOrder {
    @field("orderdate") Date orderDate;
}

Getting this wrong fails loudly with column "OrderDate" does not exist rather than silently reading the wrong data. peque's own synthetic identifiers — table aliases, joined-column aliases, generated index names — are left unquoted, since they cannot collide with a keyword.

Column defaults

peque's insert always names every column and binds the D field's value. That has one consequence worth knowing before you reach for @pgDefault: a database-level DEFAULT never fires on the peque path, because peque always supplies a value for the column.

So a default belongs in one of three places, depending on what it is:

Kind of default	Where it goes
Compile-time constant	a D field initialiser — bool active = true;
Computed per insert	applyDefaults() on the model
Database-level only	@pgDefault("…")

@model("res_partner")
struct Partner {
    @primaryKey int     id;
    @field      string  name;
    @field      bool    active = true;      // sent on every insert
    @field      SysTime createdAt;

    // Runtime values: called by insert() before the row is written.
    void applyDefaults() {
        if (createdAt == SysTime.init) createdAt = Clock.currTime;
    }
}

@pgDefault is a schema declaration, not an insert behaviour. It puts a DEFAULT in the generated DDL for the benefit of other applications writing to the table, a later ALTER TABLE … ADD COLUMN, and anyone reading the schema — peque itself overrides it every time.

The trap that follows from this:

@field @pgDefault("now()") SysTime createdAt;   // does NOT give you now()

peque sends SysTime.init, so the row gets year 1 rather than the server's clock. Use applyDefaults for that, and treat @pgDefault as documentation of what the database does when someone else inserts.

(This mirrors how SQLAlchemy splits default= from server_default=, and Django default= from db_default= — a client-side default and a database-side default are different features.)

Registry and schema

A Registry maps models to repository templates. schemaSQL generates CREATE TABLE statements for every model in the registry.

alias AppReg = Registry!(Bind!(Partner, ModelRepo!Partner));

// On first run / migration:
conn.exec(schemaSQL!AppReg());

Bind!(M, RepoTpl) associates a model with a repository template — one taking a single query-context parameter. ModelRepo!M is the ready-made one for models needing no custom methods; write your own where they do:

struct PartnerRepo(Ctx) {
    private Ctx* _ctx;
    this(Ctx* ctx) { _ctx = ctx; }
    mixin CRUDMixin!(Partner, Ctx);

    Partner[] findActive() { return query().where!"active"(true).all(); }
}

alias AppReg = Registry!(Bind!(Partner, PartnerRepo));

Getting a repository

peque provides no global session or environment object on purpose. When you know the model — which is nearly always — name its repository directly:

auto partners = PartnerRepo!Connection(&conn);
auto active   = partners.findActive();

// Inside a transaction, the same repository against a different context:
conn.transaction((ref Transaction tx) {
    PartnerRepo!Transaction(&tx).insert(p);
});

That is the ordinary path, and a registry adds nothing to it. What a registry gives you is the other direction: code generic over the model, which cannot name a repository type because it does not know one yet.

struct AppEnv {
    Connection* conn;

    auto repo(M)() {
        // D cannot chain `!` instantiations, so RegistryRepoFor!(AppReg, M)!Connection
        // does not parse. Resolve the lookup into an alias first.
        alias RepoTpl = RegistryRepoFor!(AppReg, M);
        return RepoTpl!Connection(conn);
    }
}

// Worth it when M is a template parameter — a generic CRUD endpoint, an
// import routine, an admin view — not when you could have written the type.
void deleteAny(M)(ref AppEnv env, int id) { env.repo!M.deleteById(id); }

The lookup is compile time: a model with no binding is a compile error naming the model and the registry, never a runtime null.

The borrowing rule in the next section applies to both forms: a repository — and an AppEnv holding a Connection* — does not own its context and must not outlive it.

Splitting a registry across modules

MergeRegistries concatenates registries, so each module can declare the bindings for the models it owns and the application assembles the whole:

// crm/models.d
alias CrmReg = Registry!(Bind!(Partner, PartnerRepo));

// billing/models.d
alias BillingReg = Registry!(Bind!(Invoice, ModelRepo!Invoice));

// app.d
alias AppReg = MergeRegistries!(CrmReg, BillingReg);

conn.exec(schemaSQL!AppReg());   // every table, from both modules

Merging is a plain concatenation and does not check for duplicates. Binding one model in two merged registries compiles, and schemaSQL then emits its CREATE TABLE twice; RegistryRepoFor!(AppReg, M) is what reports it, as a "Duplicate binding" compile error.

Repository CRUD

A repository borrows its context: it holds a bare Connection* (or Transaction*) and neither owns it nor keeps it alive. Build one where you use it rather than storing it in a long-lived object — returning a repository built from a local Connection, or keeping one past the end of a transaction() delegate, leaves it pointing at something gone. query() passes the same borrowed pointer to the QuerySet it returns, so the same limit applies there.

auto repo = Repository!(Partner, Connection)(&conn);

// Insert — returns the row with server-assigned id
auto p = repo.insert(Partner(0, "Acme Corp", "[email protected]", true));

// Fetch by primary key — returns Nullable!Partner
auto found = repo.findById(p.id);

// Update entire row
p.name = "Acme Ltd";
repo.update(p);

// Delete by primary key
repo.deleteById(p.id);

// Check existence without fetching the row
bool here = repo.existsById(p.id);

// Insert multiple records in a single round-trip
auto many = repo.insertMany([
    Partner(0, "Acme Corp", "[email protected]", true),
    Partner(0, "Beta Ltd",  "[email protected]",   true),
]);

// Upsert by primary key — plain INSERT when PK is 0/init, ON CONFLICT UPDATE otherwise
auto saved = repo.upsert(p);

// Upsert by natural key — conflict on any UNIQUE column(s).
// The target column must actually carry a unique constraint, or PostgreSQL
// rejects the ON CONFLICT clause. For the model above that means:
//     @field @unique string email;
auto saved2 = repo.upsert!"email"(p);

// Ignore the conflict instead of updating. DO NOTHING writes no row when one
// already exists, so this returns Nullable!M — empty means "already there".
Nullable!Partner ins = repo.insert!(OnConflict.doNothing)(p);              // any conflict
Nullable!Partner ins2 = repo.insert!(OnConflict.doNothing,
                                     Target.columns!("email"))(p);         // targeted

// The long spelling of upsert, when you want to name the target explicitly.
Partner up = repo.insert!(OnConflict.doUpdate, Target.columns!("email"))(p);

Target.columns! takes D field names, like upsert! and where!.

A @uniqueIndex(where: …) creates a partial unique index, which PostgreSQL can only infer when the statement repeats the index predicate. peque emits it for you, so both spellings work against one:

@field @uniqueIndex(where: "NOT deleted") string slug;

repo.upsert!"slug"(doc);
// INSERT … ON CONFLICT ("slug") WHERE NOT deleted DO UPDATE SET …

Without that predicate PostgreSQL answers "there is no unique or exclusion constraint matching the ON CONFLICT specification", so a model declaring one would otherwise have no usable upsert.

// Delete a record by value (extracts PK internally)
repo.deleteByRec(p);

// Bulk delete — single IN-clause round-trip; returns count deleted
long n = repo.deleteByRec(many);

QuerySet

repo.query() returns a lazy QuerySet. Filters accumulate without touching the database; a terminal method sends the query.

// All active partners
auto active = repo.query().where!"active"(true).all();

// Filtered, ordered, paginated
auto page = repo.query()
    .where!"active"(true)
    .orderBy("name ASC")
    .limit(10).offset(20)
    .all();

// Count
long n = repo.query().where!"active"(true).count();

// Exists
bool any = repo.query().where!"active"(true).exists();

// First match — returns Nullable!Partner
auto first = repo.query().where!"name"("Acme Ltd").first();
// When nothing else orders the query, first() falls back to ORDER BY <pk> so
// the answer is stable. Use .limit(1).all() if you genuinely do not care.

// Delete matching rows — returns count deleted.
// delete_()/update() affect exactly the rows all() would return, including
// relation-path predicates like F!"partner.name".isNull (LEFT JOIN semantics).
long deleted = repo.query().where!"active"(false).delete_();

// Without a where() these affect EVERY row — there is no truncation guard.
// repo.query().delete_() empties the table; make sure that is what you meant.
// Neither accepts limit()/offset(): PostgreSQL has no row bound on DELETE or
// UPDATE, so peque rejects the combination rather than silently ignoring it.

// Expression assignment — a column computed from its own current value.
// Operands are bound, never inlined, so the expression is injection-safe.
repo.query().where!"state"("queued")
    .set!"attempts"(F!"attempts" + 1)
    .set!"backoff"((F!"backoff" + 10) * 2)
    .update();

// setRaw!() for anything arithmetic cannot express — a function call, a CASE.
long claimed = repo.query().where!"state"("queued")
    .setRaw!"attempts"("attempts + 1")
    .setRaw!"lockedAt"("now()")
    .setRaw!"backoff"("LEAST(backoff * $1, $2)", 4, 3600)   // $n are this call's args
    .update();

// Partial update — set only named fields
long updated = repo.query()
    .where!"active"(false)
    .set!"name"("Archived")
    .update();

// none() — force empty result (useful when building conditional filters)
auto qs = allowedIds.empty ? repo.query().none()
                           : repo.query().whereIn!"id"(allowedIds);

// select!DTO() — project into a different struct.
// The DTO needs @autoHydrate (or @model) so its fields can be mapped.
@autoHydrate
struct PartnerSummary { int id; string name; }
PartnerSummary[] summaries = repo.query()
    .where!"active"(true)
    .select!PartnerSummary();

Every DTO member is a column on the queried table. To project a value reached through a relation, say so with @field(related: "rel.field") — peque never infers a join from a member name:

@autoHydrate
struct InvoiceSummary {
    int    id;
    string number;
    @field(related: "partner.name")         Nullable!string partnerName;
    @field(related: "partner.country.code") Nullable!string partnerCountry;
}

InvoiceSummary[] rows = invoiceRepo.query().select!InvoiceSummary();

Paths may cross up to two relations. peque adds whatever join is needed, reusing one you already asked for with load! and sharing it across members of the same relation. Since those are LEFT JOINs, a member reached through a nullable foreign key should be Nullable!T — a NULL arriving in a plain string is a ConversionError.

The path is a directive for building the query, not for decoding it: peque selects it and aliases it to the member's own column name, so the DTO also hydrates from hand-written SQL that aliases the same way (p.name AS partner_name). It must name a relation and a field on it — related: "partner" is rejected, since a scalar member cannot hold the whole related object.

The path is checked against the model when select!DTO is instantiated, so an unknown relation or field is a compile error listing what is available — not a runtime failure:

Error: No column 'nam' on Partner (@field(related: "partner.nam") on member
'partnerName'). Columns available: id, name, email, active.

A member that names neither a column nor a relation path is a compile error rather than a PostgreSQL one:

Error: select!InvoiceSummary: member 'partnerName' is not a column on Invoice.
Name the column with @field("col"), or, if the value comes through a relation,
@field(related: "rel.field") — peque does not infer a join from the member name.

Relations

Relations are declared with UDAs and loaded explicitly — peque never fetches a relation you did not ask for, so there is no lazy-loading N+1 surprise.

@model("res_partner")
struct Partner {
    @primaryKey int       id;
    @field      string    name;

    // Inverse side of Invoice.partnerId. No column of its own; filled by
    // prefetch!, empty otherwise.
    @one2many!(Invoice, "partnerId") Invoice[] invoices;

    // Many-to-many through a junction table.
    @many2many!(Tag, "partner_tag_rel", "partner_id", "tag_id") Tag[] tags;
}

@model("account_invoice")
struct Invoice {
    @primaryKey           int              id;
    @field                string           number;

    // The foreign key itself — an ordinary column.
    @many2one!(Partner)   Nullable!int     partnerId;

    // The object it points at. Not a column; filled by load!.
    @related              Nullable!Partner partner;
}

UDA	Side	Column?	Filled by
@many2one!(T)	many	yes — the FK	always (it is a column)
@related	many	no	load! / joinOne!
@one2many!(T, "fk")	one	no	prefetch!
@many2many!(T, junction, selfKey, targetKey)	—	no	prefetch!

load! — one query, LEFT JOIN

load!"field" adds a LEFT JOIN and hydrates the @related object in the same round trip. Use it for to-one relations.

auto invoices = invoiceRepo.query()
    .load!"partner"()
    .where!"number"("INV-001")
    .all();

// invoices[0].partner is populated; .isNull when the FK is NULL

Because it is a LEFT JOIN, rows with a NULL foreign key are still returned — their @related field is simply null. Relation paths in where and orderBy work whether or not you called load!; peque adds whatever join the predicate needs:

invoiceRepo.query().where(F!"partner.name"("Acme")).all();
invoiceRepo.query().orderBy(F!"partner.name".asc).all();

If a model has two foreign keys to the same table, each @related must name its backing field, or the join is ambiguous and peque rejects it at compile time:

@many2one!(Partner)           Nullable!int     invoiceAddressId;
@related("invoiceAddressId")  Nullable!Partner invoiceAddress;

@many2one!(Partner)           Nullable!int     deliveryAddressId;
@related("deliveryAddressId") Nullable!Partner deliveryAddress;

prefetch! — a second query, no row multiplication

To-many relations cannot be joined without duplicating parent rows, so prefetch! runs one extra query after the main one and stitches the results together — two queries total, regardless of how many parents matched.

auto partners = partnerRepo.query()
    .where!"active"(true)
    .prefetch!"invoices"()
    .prefetch!"tags"()
    .all();

// partners[0].invoices and .tags are filled

The order of prefetched children is undefined — no ORDER BY is emitted and the child model's @defaultOrder is not applied. Sort the array yourself if it matters.

Aggregation

Scalar aggregates run through aggregate!() with a typed field builder. The result is Nullable — SUM/AVG/MIN/MAX over zero rows is SQL NULL:

// SELECT SUM(_m.amount) FROM invoices _m WHERE (_m.status = $1)
Nullable!double total = repo.query()
    .where!"status"("open")
    .aggregate!(F!(Invoice, "amount").sum);

auto avgQty  = repo.query().aggregate!(F!(Invoice, "qty").avg);      // Nullable!double
auto maxDate = repo.query().aggregate!(F!(Invoice, "createdAt").max); // field's own type

Grouped reports use groupBy! + annotate! + select!DTO. Every DTO member must be a group key or an annotation alias — checked at compile time, so PostgreSQL's "column must appear in the GROUP BY clause" is a build error, not a runtime one:

@autoHydrate
struct OrderTotalsDTO { int orderId; long invoiceCount; double totalAmount; }

auto totals = invoiceRepo.query()
    .where!"status"("open")
    .groupBy!"orderId"
    .annotate!("invoiceCount", F!(Invoice, "id").count)
    .annotate!("totalAmount",  F!(Invoice, "amount").sum)
    .having(F!(Invoice, "amount").sum.gt(100.0))       // filter groups
    .orderBy(F!(Invoice, "amount").sum.desc)           // order by aggregate
    .select!OrderTotalsDTO();

// Raw-SQL annotation escape hatch (trusted, compile-time strings only):
.annotate!("amountSpread", "MAX(_m.amount) - MIN(_m.amount)")

Group keys are main-table columns; aggregating across a one2many is done by querying from the "many" side (as above: invoices grouped by orderId).

Type-safe predicates

F!(Model, "field") builds a compile-time field reference. Unknown field names are compile-time errors.

import peque.orm;

// Comparison operators
repo.query().where(F!(Partner, "id").gte(100)).all();
repo.query().where(F!(Partner, "name").like("Acme%")).all();
repo.query().where(F!(Partner, "name").ne("Ghost")).all();

// IN
repo.query().where(F!(Partner, "id").contains([1, 2, 3])).all();
// or sugar:
repo.query().whereIn!"id"([1, 2, 3]).all();

// IS NULL
repo.query().where(F!(Partner, "email").isNull).all();

// OR / AND / NOT composition
auto pred = F!(Partner, "active")(true) & F!(Partner, "id").gte(10);
repo.query().where(pred).all();

auto orPred = F!(Partner, "name")("Acme") | F!(Partner, "name")("Beta");
repo.query().where(orPred).all();

repo.query().where(~F!(Partner, "active")(false)).all();

// Compare two columns — pass another F! instead of a value. Nothing is bound;
// both sides are emitted as column expressions.
repo.query().where(F!(Invite, "useCount").lt(F!(Invite, "maxUses"))).all();
// WHERE (_m."use_count" < _m."max_uses")

// Arithmetic works here too — the same expressions that drive update()'s SET.
repo.query().where((F!(Job, "attempts") + 1).lte(F!(Job, "maxAttempts"))).all();
// WHERE ((_m."attempts" + $1) <= _m."max_attempts")

opCall (equality), ne, lt, lte, gt and gte all take either a value or another F!. Both sides must be the same kind of reference — two plain fields, or two relation paths (F!"a.b".lt(F!"a.c")); comparing a plain field against a relation path is a compile error.

SQL three-valued logic applies: if either column is NULL the comparison is NULL and the row does not match. No type-compatibility check is imposed, because D's own comparability is the wrong test for SQL — Nullable!int < int and Date < SysTime are both rejected by D and both accepted by PostgreSQL.

The type-free variant F!"fieldName" converts the name the same way but without model validation. Two things follow: field-name typos become PostgreSQL runtime errors rather than compile-time failures, and — because it never consults the model — it cannot see an @field("col") rename:

@field("uses_n") int useCount;          // column is uses_n

F!(Invite, "useCount")   //  _m."uses_n"    — consults the model
F!"useCount"             //  _m."use_count" — converts the name, misses the rename

If the typed form is too wordy, partially apply the model once. This keeps compile-time checking and @field awareness, and still allows aggregates:

alias I(string f) = F!(Invite, f);

repo.query().where(I!"useCount".lt(I!"maxUses")).all();

repo.query().where(F!"active"(true)).all();
repo.query().where(F!"id".gte(10)).all();

Raw SQL escape hatch

whereRaw embeds a SQL fragment verbatim — placeholders use local $1/$2 numbering and are renumbered automatically relative to prior filters.

repo.query().whereRaw("tsv @@ to_tsquery($1)", "acme & corp").all();

Security: sqlFrag is embedded in the query verbatim — never pass user-controlled input as the first argument. All runtime values must go through the variadic args.

EXISTS subqueries

@model("invoices")
struct Invoice {
    @primaryKey int    id;
    @field      int    partnerId;
    @field      string status;
}

alias InvoiceRepo = Repository!(Invoice, Connection);

// Partners that have at least one open invoice
partnerRepo.query()
    .where(
        exists!(Invoice)(
            SF!(Invoice, "partnerId")(F!(Partner, "id")) &
            SF!(Invoice, "status")("open")
        )
    )
    .all();

// Partners with NO invoices at all
partnerRepo.query()
    .where(~exists!(Invoice)(
        SF!(Invoice, "partnerId")(F!(Partner, "id"))
    ))
    .all();

Note: single-level exists!() only. Nested exists!() calls conflict on the _sq alias and throw NotSupportedError at serialisation time.

IN subqueries

asSubquery!"field"() captures a QuerySet as a single-column subquery atom without hitting the database. Pass it to F!(M,"field").inSubquery() for IN (SELECT …), or negate with ~ for NOT IN. The subquery keeps the QuerySet's ORDER BY (explicit or @defaultOrder), so orderBy(F!"amount".desc).limit(5).asSubquery!"id"() really is "ids of the top 5 by amount", not 5 arbitrary rows.

// IDs of active categories — no DB call yet
auto activeCatIds = catRepo.query()
    .where!"active"(true)
    .asSubquery!"id"();

// Products whose category is in that set
auto products = prodRepo.query()
    .where(F!(Product, "categoryId").inSubquery(activeCatIds))
    .all();

// Products whose category is NOT in that set
auto rest = prodRepo.query()
    .where(~F!(Product, "categoryId").inSubquery(activeCatIds))
    .all();

Migrations (peque:migrate)

Experimental. The API is still moving — expect breaking changes on a minor version bump. Implemented with heavy use of AI coding assistants in autonomous mode; see Status of the subpackages.

Migrations are plain D structs compiled into the application binary. Each struct has up() and optionally down(). Version numbers are assigned by position in MigrationList — never reorder migrations.

up()/down() take ref Transaction: each migration runs inside its own transaction together with the row that records it, so the two commit or roll back as one. ref Connection is still accepted for compatibility, but it lets a migration end that transaction early and break the guarantee.

import peque;
import peque.migrate;

struct V1_CreateUsers {
    enum description = "create users table";
    void up(ref Transaction tx) {
        tx.exec(`CREATE TABLE users (
            id    serial PRIMARY KEY,
            name  text   NOT NULL,
            email text   NOT NULL DEFAULT ''
        )`);
    }
    void down(ref Transaction tx) {
        tx.exec(`DROP TABLE users`);
    }
}

struct V2_AddIndex {
    enum description = "index users.email";
    void up(ref Transaction tx) {
        tx.exec(`CREATE INDEX ON users (email)`);
    }
    // no down() — irreversible; rollback throws MigrationError
}

alias AppMigrations = MigrationList!(V1_CreateUsers, V2_AddIndex);

Running migrations

auto m = Migrator!(AppMigrations)(&conn, "myapp");

m.migrate();          // apply all pending (advisory-locked, each in its own transaction)
m.rollback(1);        // roll back the last applied migration (requires down())
m.status();           // returns MigrationStatus[] with applied / pending info

Integration with peque:orm

The first migration can reuse schemaSQL to create all ORM-managed tables:

struct V1_InitSchema {
    enum description = "create all tables";
    void up(ref Connection conn) {
        conn.exec(schemaSQL!AppReg());
    }
}

Multiple namespaces

Libraries and applications can share a database with independent version sequences:

Migrator!(LibMigrations)(&conn, "mylib").migrate();
Migrator!(AppMigrations)(&conn, "myapp").migrate();

Checksum verification

Checksums are opt-in. A migration that declares one:

struct M3_AddIndex {
    enum description = "index sale_order.partner_id";
    enum checksum    = "2024-06-01a";   // bump when the SQL below changes
    void up(ref Transaction tx) { tx.exec("CREATE INDEX ..."); }
}

has that value stored on first apply, and any later run — migrate() or rollback() — throws MigrationError if the declared value no longer matches what the database recorded.

The checksum is a value you declare, not a hash of the SQL: up() is ordinary D code and D offers no way to read a function body, so peque cannot compute one for you. Bump it whenever you change the migration's effect. A migration that declares no checksum is simply not checked, which means renaming its module or struct, or editing its description, can never brick a deployed database.

Migrations the runner refuses to run

migrate(), status() and rollback() all reject a database state the compiled list cannot describe:

• a recorded version beyond the end of the list — the database was migrated by a newer build, so this one would mis-attribute versions;
• a gap, e.g. v2 recorded while v1 is not — since versions are list positions, that means the list was reordered or extended in the middle, and applying the missing one now would run it out of order.

Statements that cannot run in a transaction

Each migration runs inside its own transaction. For statements PostgreSQL refuses there — CREATE INDEX CONCURRENTLY, ALTER TYPE ... ADD VALUE — opt out:

struct M4_ConcurrentIndex {
    enum description   = "concurrent index";
    enum transactional = false;
    void up(ref Connection conn) {
        conn.exec("CREATE INDEX CONCURRENTLY ... ");
    }
}

Such a migration is not atomic with its own bookkeeping row, so write it idempotently (IF NOT EXISTS): a crash between the two leaves the change applied but unrecorded, and the next run retries it.

vibe.d (peque:vibe)

Implemented with heavy use of AI coding assistants in autonomous mode; see Status of the subpackages.

peque:vibe provides a fiber-aware wait strategy and connection pool for vibe.d applications. Instead of blocking the OS thread while waiting for PostgreSQL, control yields to the vibe.d event loop.

dependency "peque:vibe" version="~>0.2.0"

import peque;
import peque.vibe;

// Single connection with fiber-aware I/O
auto conn = Connection(params, VibeWaitStrategy());

// Connection pool — makeVibePool injects VibeWaitStrategy and non-blocking mode
auto pool = makeVibePool(8, [
    "dbname": "myapp",
    "user":   "app",
    "host":   "localhost",
    "port":   "5432",
]);

// Borrow a connection for the duration of a delegate; returned automatically
auto result = pool.borrow((ref Connection conn) {
    return conn.execParams("SELECT name FROM users WHERE id = $1", userId);
});

LISTEN / NOTIFY

peque exposes PostgreSQL's notification bus: listen()/unlisten() subscribe a connection to channels, and waitNotifications(Duration) delivers Notification { channel, payload, backendPid } values with a bounded wait — the shape a server-sent-events hub or cache invalidator needs.

import core.time: seconds;
import peque;

// The listening connection must be DEDICATED: autocommit (no open
// transactions — the server delivers notifications only between
// transactions), never pooled, owned by a single consumer loop.
auto conn = Connection(params);            // or Connection(params, VibeWaitStrategy())
conn.listen("events");                     // channel name is identifier-quoted

bool running = true;
while (running) {
    // Bounded wait doubles as the heartbeat tick: empty result on timeout.
    foreach (n; conn.waitNotifications(30.seconds))
        dispatch(n.channel, n.payload);
    // ...check stop flag, send SSE heartbeat, verify conn.status() here...
}

Publishing needs no dedicated API — pg_notify is a regular parameterized query, and NOTIFY is transactional (delivered on COMMIT, discarded on ROLLBACK):

conn.execParams("SELECT pg_notify($1, $2)", "events", payload);

getNotifications() is the non-blocking variant (drain only, never waits). waitNotifications drains libpq's buffer before waiting, so notifications that arrived during earlier traffic are returned immediately; a zero timeout makes it a pure non-blocking check.

Caveats worth knowing:

• Delivery happens only between transactions — keep the listening connection out of transactions and out of pools.
• Subscriptions do not survive reconnect. On a dead connection (conn.status() != CONNECTION_OK), build a fresh Connection and re-issue listen() for every channel (peque deliberately has no PQreset wrapper).
• The server deduplicates identical `(channel, payload)` notifications sent within one transaction.
• Payloads are limited to ~8000 bytes — send an ID, not a document.
• waitNotifications requires the connection's WaitStrategy to provide the optional timed overload bool wait(int fd, WaitMask mask, Duration timeout). PollWaitStrategy (default) and VibeWaitStrategy both do; a custom strategy without it keeps working for queries and getNotifications().

Error handling

Every peque exception derives from PequeException, and each carries structured fields — acting on an error never requires parsing its message. That matters because PostgreSQL localises its messages via lc_messages, which a non-superuser cannot override, so text matching is unsound in principle.

PequeException                  root — never thrown directly
├── LibpqLoadError              libpq itself could not be loaded (dynamic builds)
├── ConnectionError             the link is unusable
├── NotSupportedError           peque will not do this, in any context
├── ConversionError             a value could not be converted, either direction
├── QueryError                  category — scoped to running a query
│   ├── QueryClientError        your call is wrong
│   │   └── QueryEscapingError  …an identifier/JSON key that cannot be escaped
│   └── QueryServerError        PostgreSQL rejected it — carries SQLSTATE
│       ├── IntegrityError      SQLSTATE class 23
│       └── SerializationError  SQLSTATE class 40
└── ResultError                 the result has no such row or column
    ├── RowNotExistsError
    └── ColNotExistsError

Constraint violations

QueryServerError carries the backend's diagnostics, captured as the exception is built — the underlying result is freed while the stack unwinds, so they cannot be read afterwards.

try {
    repo.insert(user);
} catch (IntegrityError e) {
    final switch (e.kind) {
        case IntegrityKind.unique:     return conflict(e.constraintName);
        case IntegrityKind.foreignKey: return badReference(e.constraintName);
        case IntegrityKind.notNull:    return missingField(e.columnName);
        case IntegrityKind.check:
        case IntegrityKind.exclusion:
        case IntegrityKind.restrict:
        case IntegrityKind.other:      return unprocessable(e.messagePrimary);
    }
}

Which fields the server populates depends on the violation, and the asymmetry is PostgreSQL's, not peque's:

| SQLSTATE | violation | constraintName | columnName | |---|---|:--:|:--:| | 23502 | not null | — | ✓ | | 23503 | foreign key | ✓ | — | | 23505 | unique | ✓ | — |

For unique and foreign-key violations the offending columns appear only inside the localised DETAIL text, which peque deliberately does not parse. Map the constraint name to your own fields instead. A field the server did not supply is an empty string.

Retrying

Retry-ability cuts across SQLSTATE classes, so it is a predicate rather than a branch of the tree:

foreach (attempt; 0 .. 3) {
    try {
        conn.transaction!(OnSuccess.commit, IsolationLevel.serializable)((ref tx) { … });
        break;
    } catch (QueryServerError e) {
        if (!e.isRetriable() || attempt == 2) throw e;
    } catch (ConnectionError e) {
        // The link is gone, so this needs a fresh connection rather than a
        // replay on the same one — take one from the pool before retrying.
        if (attempt == 2) throw e;
    }
}

ConnectionError is a sibling of QueryError, not a subclass, so a loop that catches only QueryServerError will not see a dropped connection.

isRetriable() covers serialization failures, deadlocks and lock timeouts, which can be retried on the same connection, plus connection-class failures, which need a fresh one. Codes with an unknown outcome — 40003, and 57014 for a cancellation you requested — are deliberately excluded.

sqlstate is always populated on a QueryServerError, and the exception type is chosen from the SQLSTATE class, never the full code — so an unrecognised class-23 code still arrives as an IntegrityError with kind == other rather than falling back to the base type.

Running tests

Integration tests require a running PostgreSQL instance. Configure via environment variables (defaults shown):

POSTGRES_DB=peque-test \
POSTGRES_USER=peque \
POSTGRES_PASSWORD=peque \
POSTGRES_HOST=localhost \
POSTGRES_PORT=5432 \
dub test --config=unittestStatic

Sub-package tests:

dub test :orm     --config=unittestStatic
dub test :migrate --config=unittestStatic
dub test :vibe    --config=unittestStatic

Substitute unittestDynamic to exercise the runtime-loaded libpq path. CI runs all four suites on every push, across dmd and ldc, both linking modes, and PostgreSQL 15–18.

License

Mozilla Public License 2.0