Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://koskimas.github.io/kysely
A type-safe typescript SQL query builder
https://koskimas.github.io/kysely
browser bun database deno microsoft-sql-server mssql mysql nodejs postgresql query-builder sql sqlite type-safe typescript
Last synced: 3 months ago
JSON representation
A type-safe typescript SQL query builder
- Host: GitHub
- URL: https://koskimas.github.io/kysely
- Owner: kysely-org
- License: mit
- Created: 2021-02-22T09:06:55.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-22T12:42:40.000Z (7 months ago)
- Last Synced: 2024-04-22T20:12:35.423Z (7 months ago)
- Topics: browser, bun, database, deno, microsoft-sql-server, mssql, mysql, nodejs, postgresql, query-builder, sql, sqlite, type-safe, typescript
- Language: TypeScript
- Homepage: https://kysely.dev
- Size: 49.2 MB
- Stars: 9,277
- Watchers: 24
- Forks: 220
- Open Issues: 85
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-template-literal-types - WebSite
README
[](https://stand-with-ukraine.pp.ua)
[](https://discord.gg/xyBJ3GwvAm)
[](https://github.com/kysely-org/kysely)
[](https://github.com/kysely-org/kysely/blob/master/LICENSE)
[](https://github.com/kysely-org/kysely/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
[](https://github.com/kysely-org/kysely/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc)
[](https://www.npmjs.com/package/kysely)
[](https://bundlephobia.com/package/kysely)
[](https://twitter.com/kysely_)
# [Kysely](https://kysely.dev)
Kysely (pronounce “Key-Seh-Lee”) is a type-safe and autocompletion-friendly [TypeScript](https://www.typescriptlang.org/) [SQL](https://en.wikipedia.org/wiki/SQL) query builder.
Inspired by [Knex.js](http://knexjs.org/). Mainly developed for [Node.js](https://nodejs.org/en/) but also
runs on all other [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript) environments like [Deno](https://deno.com/), [Bun](https://bun.sh/), [Cloudflare Workers](https://workers.cloudflare.com/)
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](https://kysely-org.github.io/kysely-apidoc/interfaces/Sql.html)
and the [DynamicModule](https://kysely-org.github.io/kysely-apidoc/classes/DynamicModule.html#ref) 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](https://kysely-org.github.io/kysely-apidoc/).
If you start using Kysely and can't find something you'd want to use, please open an issue or join our
[Discord server](https://discord.gg/xyBJ3GwvAm).
# Getting started
Please visit our documentation site [kysely.dev](https://kysely.dev) to get started. We also have a comprehensive
API documentation hosted [here](https://kysely-org.github.io/kysely-apidoc/), but you can access the same
documentation in your IDE by hovering over a class/method/property/whatever.
# Contributors
Want to contribute? Check out our contribution guidelines.
