@xfcfam/xf-sql-postgres

@xfcfam/xf-sql-postgres

PostgreSQL dialect adapter for @xfcfam/xf-sql — Kysely's PostgresDialect over pg, plus the SQLSTATE → typed-Exception translation, so the Business Layer never sees pg errors.

pg and kysely are bundled and wired internally — the adapter builds the pg.Pool and the dialect in its constructor. You never install or import either.

Install

npm i @xfcfam/xf @xfcfam/xf-sql @xfcfam/xf-sql-postgres

Quick start

import { PostgresDatabaseRepository } from '@xfcfam/xf-sql-postgres'
import { UniqueViolationException } from '@xfcfam/xf-sql'

export class UsersDb extends PostgresDatabaseRepository<Schema> {
  constructor() { super({ connectionString: process.env.DATABASE_URL!, pool: { max: 10 } }) }

  createUser(input: NewUser) {
    return this.exec(() =>
      this.db.insertInto('users').values(input).returningAll().executeTakeFirstOrThrow())
  }
}

Exported Components

Generalizations

Utilities

SQLSTATE mapping — 23505 → UniqueViolation, 23503 → ForeignKeyViolation, 23514 → Check, 23502 → NotNull, 40P01 → Deadlock, transport codes → Connection. table / column / constraint are forwarded onto the exception.

Documentation

Full specification → xfcfam.org · SQLSTATE codes

License

MIT