pgsql-codegen

pg-codegen

Generate fully-typed TypeScript classes and interfaces from a live PostgreSQL schema via introspection.

Converts your PostgreSQL tables into idiomatic TypeScript code — fast, predictable, and schema-aware.

✨ Features

🧠 Intelligent Introspection Pulls schema structure using native SQL introspection — no GraphQL required.

🧱 Interface + Class Output Generates matching interface + class pairs for each table using PascalCase naming.

🧹 Schema-Aware Output Writes files into schemas/<schema>.ts, grouped and re-exported from an index.ts.

🔗 Type Mapping for Postgres Primitives Supports UUID, Timestamp, Boolean, Text, Int, and nullable detection.

🪴 Auto Imports from _common.ts Deduplicates and imports shared scalar types intelligently.

🧪 Snapshot-Ready for Testing Babel AST-based output is stable and perfect for inline snapshot tests.

🛠️ Install

npm install pg-codegen

🚀 Usage

import { generateCodeTree } from 'pg-codegen';
import getIntrospectionRows from 'pg-codegen/introspect';

const rows = await getIntrospectionRows({
  client: pgClient,
  introspectionOptions: {
    pgLegacyFunctionsOnly: false,
    pgIgnoreRBAC: true
  },
  namespacesToIntrospect: ['my_schema'],
  includeExtensions: false
});

const output = generateCodeTree(rows, {
  includeUUID: true,
  includeTimestamps: true
});

// Example: write output['schemas/my_schema.ts'] to disk

📟 Example Output

// schemas/_common.ts
export type UUID = string;
export type Timestamp = string;

// schemas/my_schema.ts
import { UUID, Timestamp } from './_common';

export interface Users {
  id: UUID;
  email: string;
  created_at: Timestamp;
}

export class Users implements Users {
  id: UUID;
  email: string;
  created_at: Timestamp;

  constructor(data: Users) {
    this.id = data.id;
    this.email = data.email;
    this.created_at = data.created_at;
  }
}

Related LaunchQL Tooling

🧪 Testing

• launchql/pgsql-test: 📊 Isolated testing environments with per-test transaction rollbacks—ideal for integration tests, complex migrations, and RLS simulation.
• launchql/graphile-test: 🔐 Authentication mocking for Graphile-focused test helpers and emulating row-level security contexts.
• launchql/pg-query-context: 🔒 Session context injection to add session-local context (e.g., SET LOCAL) into queries—ideal for setting role, jwt.claims, and other session settings.

🧠 Parsing & AST

• launchql/pgsql-parser: 🔄 SQL conversion engine that interprets and converts PostgreSQL syntax.
• launchql/libpg-query-node: 🌉 Node.js bindings for libpg_query, converting SQL into parse trees.
• launchql/pg-proto-parser: 📦 Protobuf parser for parsing PostgreSQL Protocol Buffers definitions to generate TypeScript interfaces, utility functions, and JSON mappings for enums.
• @pgsql/enums: 🏷️ TypeScript enums for PostgreSQL AST for safe and ergonomic parsing logic.
• @pgsql/types: 📝 Type definitions for PostgreSQL AST nodes in TypeScript.
• @pgsql/utils: 🛠️ AST utilities for constructing and transforming PostgreSQL syntax trees.
• launchql/pg-ast: 🔍 Low-level AST tools and transformations for Postgres query structures.

🚀 API & Dev Tools

• launchql/server: ⚡ Express-based API server powered by PostGraphile to expose a secure, scalable GraphQL API over your Postgres database.
• launchql/explorer: 🔎 Visual API explorer with GraphiQL for browsing across all databases and schemas—useful for debugging, documentation, and API prototyping.

🔁 Streaming & Uploads

• launchql/s3-streamer: 📤 Direct S3 streaming for large files with support for metadata injection and content validation.
• launchql/etag-hash: 🏷️ S3-compatible ETags created by streaming and hashing file uploads in chunks.
• launchql/etag-stream: 🔄 ETag computation via Node stream transformer during upload or transfer.
• launchql/uuid-hash: 🆔 Deterministic UUIDs generated from hashed content, great for deduplication and asset referencing.
• launchql/uuid-stream: 🌊 Streaming UUID generation based on piped file content—ideal for upload pipelines.
• launchql/upload-names: 📂 Collision-resistant filenames utility for structured and unique file names for uploads.

🧰 CLI & Codegen

• @launchql/cli: 🖥️ Command-line toolkit for managing LaunchQL projects—supports database scaffolding, migrations, seeding, code generation, and automation.
• launchql/launchql-gen: ✨ Auto-generated GraphQL mutations and queries dynamically built from introspected schema data.
• @launchql/query-builder: 🏗️ SQL constructor providing a robust TypeScript-based query builder for dynamic generation of SELECT, INSERT, UPDATE, DELETE, and stored procedure calls—supports advanced SQL features like JOIN, GROUP BY, and schema-qualified queries.
• @launchql/query: 🧩 Fluent GraphQL builder for PostGraphile schemas. ⚡ Schema-aware via introspection, 🧩 composable and ergonomic for building deeply nested queries.

Disclaimer

AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED "AS IS", AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.

No developer or entity involved in creating this software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the code, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.