kysely README

The project's README from github.com/kysely-org/kysely. As one markdown file: README.md.

Stand With Ukraine

NPM Version Socket Badge Tests License Issues Pull Requests GitHub contributors NPM Downloads JSR Downloads JSR Score

Join the discussion ⠀⠀⠀⠀⠀⠀⠀

Discord Bluesky

Get started

PostgreSQL MySQL MSSQL SQLite PGlite & more!

Kysely

Kysely (pronounce “Key-Seh-Lee”) is a type-safe and autocompletion-friendly TypeScript SQL query builder. Inspired by Knex.js. Mainly developed for Node.js but also runs on all other JavaScript environments like Deno, Bun, Cloudflare Workers and web browsers.

Kysely makes sure you only refer to tables and columns that are visible to the part of the query you're writing. The result type only has the selected columns with correct types and aliases. As an added bonus you get autocompletion for all that stuff.

As shown in the gif above, through the pure magic of modern TypeScript, Kysely is even able to parse the alias given to pet.name and add the pet_name column to the result row type. Kysely is able to infer column names, aliases and types from selected subqueries, joined subqueries, with statements and pretty much anything you can think of.

Of course there are cases where things cannot be typed at compile time, and Kysely offers escape hatches for these situations. See the sql template tag and the DynamicModule for more info.

All API documentation is written in the typing files and you can simply hover over the module, class or method you're using to see it in your IDE. The same documentation is also hosted here.

If you start using Kysely and can't find something you'd want to use, please open an issue or join our Discord server.

Getting started

Please visit our documentation site kysely.dev to get started. We also have a comprehensive API documentation hosted here, but you can access the same documentation in your IDE by hovering over a class/method/property/whatever.

Core team

Project leads

Responsible for project direction, API design, maintenance, code reviews, community support, documentation, and working on some of the most impactful/challenging things.


Sami Koskimäki

(the author)

Igal Klebanov

(the dynamo)

Honorable mentions

People who had special impact on the project and its growth.


Fernando Hurtado

(1st docs)

Wirekang

(playground)

Tim Griesser

(Knex)

Robin Blomberg

(codegen)

Shoubhit Dash

(prisma idea)

Valtýr Örn Kjartansson

(prisma impl)

Dax Raad

(early adopter)

Theo Browne

(early promoter)

Lee Robinson

(early promoter)

Ethan Resnick

(timely feedback)

Harminder Virk

(dope writeup)

Johan Eliasson

(promoter/educator)

All contributors


Want to contribute? Check out our contribution guidelines.

Powered by Vercel

kysely (kysely-org/kysely)

query-builder
Searching Database…

14.3K ·GitHub
What is this?Kysely (pronounced 'Key-Seh-Lee') is a type-safe, autocompletion-friendly SQL query builder for TypeScript, inspired by Knex.js: it checks your queries at compile time and types the results.
So it's a library I add to my project, not a tool I run?Exactly — a library. You write queries in your TypeScript code, Kysely builds the SQL, and the rows that come back are fully typed.
Where does it run — is Node.js the only option?Node.js is the main target (Node 22+ per its package metadata), but it also runs on Deno, Bun, Cloudflare Workers and in web browsers — and the package ships without runtime dependencies.
What if part of my query can't be typed at compile time?Kysely has escape hatches for exactly those cases: the sql template tag for raw SQL and the DynamicModule for dynamic situations.
Do I need a TypeScript project for this to make sense?Yes — it is built for TypeScript codebases: the compile-time checks and autocompletion come from static types. You could call it from plain JavaScript, but you would lose the type safety that is the whole point.
What does the type safety actually buy me?Compile-time guarantees: you can only reference tables and columns visible at that point of the query, and the result type contains exactly the selected columns with correct types and aliases — plus autocompletion while you write.
How smart is it about aliases and subqueries?Very: it parses an alias like pet.name into a typed petname column in the result row, and infers column names, aliases and types from selected subqueries, joined subqueries and with statements.
Which databases does it support?Its repo topics list PostgreSQL, MySQL, SQLite and Microsoft SQL Server (MSSQL).
How do you pronounce the name?'Key-Seh-Lee' — the README settles that in its first line.
What are similar projects?sequelize, orm, typeorm, directus, diesel, efcore, pglite, remix
Creator
kysely-org
Size
58.2 MB
Stars
14.3K
Age
5y
Commits · 90 Days