pgbo

Three-layer architecture

Tables for storage, views for access, Business Objects for lifecycle. Application code only talks to views.

Type inference, no codegen

InferRow, InferInsert, InferUpdate, InferViewRow derive TS types from your schema at compile time via generics.

PostgreSQL-native

Domains, updatable views, materialized views, range types, JSONB, arrays, enums, INSTEAD OF triggers.

Auto-migration

CLI introspects pg_catalog, diffs against your TypeScript definitions, executes migration plans transactionally.

Read-only by default

BOs only allow writes when actions are explicitly defined. Compositions, associations, lifecycle hooks built in.

Framework adapters

@pgbo/core is framework-agnostic. @pgbo/fastify plugs into Fastify for CRUD routes, metadata, and pagination.

Quick start

bash

npm install @pgbo/core

typescript

import { createDatabase } from '@pgbo/core'
import { table, view, text, integer } from '@pgbo/core/schema'

const warehouse = table('warehouse', {
  columns: {
    slug: text().notNull(),
    name: text().notNull(),
    capacity: integer().min(0),
  },
  primaryKey: ['slug'],
})

const warehouseView = view('warehouse_view').from(warehouse)

const db = createDatabase({ connectionString: 'postgresql://localhost/mydb' })
const rows = await db.from(warehouseView).execute()

The three-layer model

┌─────────────────────────────────────────────────┐
│  Business Object (BO)                           │
│  Marks a view as a managed entity.              │
│  Owns CRUD lifecycle, permissions, hooks.       │
├─────────────────────────────────────────────────┤
│  View                                           │
│  PostgreSQL VIEW — the read/write interface.    │
│  Application code only talks to views.          │
├─────────────────────────────────────────────────┤
│  Table                                          │
│  PostgreSQL TABLE — pure data storage.          │
│  Never accessed directly by application code.   │
└─────────────────────────────────────────────────┘

Application code never touches tables directly. All reads and writes flow through views. Views become Business Objects when they need CRUD lifecycle, permissions, and hooks.

pgboType-safe PostgreSQL Business Objects