Install & Compatibility
Where this runs
No compatibility data collected yet for this library.
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
pgCodegen
✓ import { pgCodegen } from "kysforge/pg";
✗ import { pgCodegen } from "kysforge";
Must import from 'kysforge/pg' subpath; default export not available.
liteCodegen
✓ import { liteCodegen } from "kysforge/lite";
✗ import { sqliteCodegen } from "kysforge/lite";
Function named liteCodegen, not sqliteCodegen. Import from 'kysforge/lite'.
PgCodegenResult
✓ import type { PgCodegenResult } from "kysforge/pg";
✗ import { PgCodegenResult } from "kysforge/pg";
Type import recommended; it's only a type.
Generates Kysely Database interface from PostgreSQL by introspecting schemas, tables, views, and enums, writing typed output files.
import { pgCodegen } from "kysforge/pg";
const result = await pgCodegen({
connection: {
host: process.env.PGHOST ?? "localhost",
port: Number(process.env.PGPORT) || 5432,
database: process.env.PGDATABASE ?? "my_db",
user: process.env.PGUSER ?? "dev",
password: process.env.PGPASSWORD ?? "",
},
driver: "pg",
schemas: ["public"],
output: {
database: "./src/database.generated.ts",
enums: "./src/enums.generated.ts",
},
views: true,
});
console.info(`Generated ${result.tables} table(s), ${result.enums} enum(s), ${result.views} view(s)`);
for (const w of result.warnings) console.warn(w);
Errors
Common errors & fixes
Cannot find module 'pg' or its corresponding type declarations
Missing peer dependency for PostgreSQL codegen using 'pg' driver.
fixInstall pg: npm install pg
No such export 'sqliteCodegen' from 'kysforge/lite'
Attempting to import a function named 'sqliteCodegen' but the actual export is 'liteCodegen'.
fixUse import { liteCodegen } from 'kysforge/lite'; TypeError: Cannot read properties of undefined (reading 'host')
Connection object passed to pgCodegen is missing required fields (host, database, user, password).
fixEnsure connection object has host, database, user, password properties. Port defaults to 5432.
Error: The '--experimental-sqlite' flag is required to use node:sqlite on Node 22-23.
SQLite codegen requires Node.js experimental flag for versions before 24.
fixRun script with: node --experimental-sqlite your-script.js
Audit
Dependencies
kyselyrequiredPeer dependency: provides types and runtime for Kysely ORM.
pgoptionalOptional PostgreSQL driver (node-postgres) — install only if using PostgreSQL and choosing this driver.
postgresoptionalOptional PostgreSQL driver (postgres.js) — install only if using PostgreSQL and choosing this driver.
kysely-postgres-jsoptionalRequired peer when using postgres.js driver for PostgreSQL codegen.