kysely-codegen generates Kysely type definitions from your database. That's it.

Table of contents

• Installation
• Generating type definitions
• Using the type definitions

Installation

npm install --save-dev kysely-codegen

# You will also need to install Kysely with your driver of choice:
npm install kysely pg
npm install kysely mysql2
npm install kysely better-sqlite3
npm install @libsql/kysely-libsql

Generating type definitions

The most convenient way to get started is to create an .env file with your database connection string:

# PostgreSQL
DATABASE_URL=postgres://username:password@yourdomain.com/database

# MySQL
DATABASE_URL=mysql://username:password@yourdomain.com/database

# SQLite
DATABASE_URL=C:/Program Files/sqlite3/db

# LibSQL
DATABASE_URL=libsql://token@host:port/database

If your URL contains a password with special characters, those characters may need to be percent-encoded.

If you are using PlanetScale, make sure your URL contains this SSL query string parameter: ssl={"rejectUnauthorized":true}

Then run:

kysely-codegen

This command will generate a .d.ts file from your database, for example:

1import { ColumnType } from 'kysely';
2
3export type Generated<T> = T extends ColumnType<infer S, infer I, infer U>
4  ? ColumnType<S, I | undefined, U>
5  : ColumnType<T, T | undefined, T>;
6
7export type Timestamp = ColumnType<Date, Date | string, Date | string>;
8
9export interface Company {
10  id: Generated<number>;
11  name: string;
12}
13
14export interface User {
15  company_id: number | null;
16  created_at: Generated<Timestamp>;
17  email: string;
18  id: Generated<number>;
19  is_active: boolean;
20  name: string;
21  updated_at: Timestamp;
22}
23
24export interface DB {
25  company: Company;
26  user: User;
27}

For more options, run kysely-codegen --help.

Using the type definitions

Import DB into new Kysely<DB>, and you're done!

1import { Kysely, PostgresDialect } from 'kysely';
2import { DB } from 'kysely-codegen';
3import { Pool } from 'pg';
4
5const db = new Kysely<DB>({
6  dialect: new PostgresDialect({
7    pool: new Pool({
8      connectionString: process.env.DATABASE_URL,
9    }),
10  }),
11});
12
13const rows = await db.selectFrom('user').selectAll().execute();
14//    ^ { company_id: number | null; created_at: Date; email: string; id: number; ... }[]