Registry / database / sql-code-generator

sql-code-generator

library0.10.1jsnpmunverified

A CLI tool that generates TypeScript type definitions and typed query functions from SQL schemas and queries, supporting PostgreSQL and MySQL. At version 0.10.1, it's in early development with an oclif-based CLI. Key differentiators: generates both types and executable query functions, works with existing .sql files and .ts files containing SQL strings, and uses a single config file (codegen.sql.yml). Requires peer dependency yesql 3.2.2. Inspired by graphql-code-generator.

database

npm install sql-code-generator

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · SQL-CODE-GENERATOR

sql-code-generator

databasejavascriptv0.10.1

harness data pending

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.

generate

✓ import { generate } from 'sql-code-generator';

✗ const generate = require('sql-code-generator');

Package is ESM-only; no CommonJS support.

SqlTablePhoto

✓ import { SqlTablePhoto } from './dao/generated/types';

Generated types are exported from the file specified in the config (`generates.types`).

Installation, config setup, and running the generator to produce TypeScript types and query functions from SQL schemas.

// Install npm install --save-dev sql-code-generator yesql // Create codegen.sql.yml /* language: postgres dialect: 10.7 resources: - "schema/**/*.sql" queries: - "src/dao/**/*.ts" - "!src/**/*.test.ts" generates: types: src/dao/generated/types.ts queryFunctions: src/dao/generated/queryFunctions.ts */ // Run npx sql-code-generator generate

Debug

Known issues

breakingPackage version 0.x may introduce breaking changes in minor releases.

fix

Pin to exact version in package.json.

affects: <1.0.0

gotchaMissing peer dependency yesql (3.2.2) will cause runtime errors.

fix

Install yesql as a dependency: npm install yesql@3.2.2

affects: >=0.0.0

gotchaConfig file must be named codegen.sql.yml in project root, or path must be provided via --config.

fix

Ensure file exists at project root or use --config <path>

affects: >=0.0.0

Errors

Common errors & fixes

Cannot find module 'yesql'

Missing peer dependency yesql.

fix

Run: npm install yesql@3.2.2

Error: No config file found

The required codegen.sql.yml file is missing.

fix

Create codegen.sql.yml in the project root or specify with --config.

Upgrade

Version history

0.10.1latest on npm

Audit

Dependencies

yesqlrequiredpeer dependency for SQL query generation

Agent activity

13 hits · last 30 days

node