Prisma Kysely Extension
Writing and maintaining raw SQL queries for Prisma can be a tedious and error-prone task. The moment you need to write a query that is not supported out-of-the-box by Prisma, you lose all of that type-safety and autocompletion. This is where prisma-extension-kysely
comes in! It allows you to easily write raw SQL queries in a type-safe manner with kysely
and integrate them seamlessly with Prisma.
And the best part? You can use all of your favorite kysely
plugins with prisma-extension-kysely
too!
You don't have to take our word for it, though:
I have to say, this is BY FAR the most amazing community package I've seen in the Prisma ecosystem!
It makes it so much more convenient to drop down to raw SQL when needed without sacrificing DX — best of both worlds! 🚀
— Nikolas Burk, DevRel @ Prisma
Features
- Type-safe — Write raw SQL queries in a type-safe manner with
kysely
- Seamless integration — Use
kysely
queries with Prisma as if they were native - Autocompletion — Get autocompletion for your queries in your IDE
- Type inference — Get type inference for your queries in your IDE
Get started
Click the Use this template button and provide details for your Client extension
Install the dependencies:
npm install prisma-extension-kysely kysely
Set up the excellent prisma-kysely
library to automatically generate types for your database:
npm install -D prisma-kysely
Add prisma-kysely
as a generator to your schema.prisma
:
generator kysely {
provider = "prisma-kysely"
}
Generate the types:
npx prisma generate
Extend your Prisma Client:
import kyselyExtension from "prisma-extension-kysely";
import type { DB } from "./prisma/generated/types";
const prisma = new PrismaClient().$extends(
kyselyExtension({
kysely: (driver) =>
new Kysely<DB>({
dialect: {
createDriver: () => driver,
createAdapter: () => new PostgresAdapter(),
createIntrospector: (db) => new PostgresIntrospector(db),
createQueryCompiler: () => new PostgresQueryCompiler(),
},
plugins: [
],
}),
}),
);
It's that simple! Now you can write raw SQL queries with kysely
and use them with Prisma:
const result = prisma.$queryRaw`SELECT * FROM User WHERE id = ${id}`;
const query = prisma.$kysely
.selectFrom("User")
.selectAll()
.where("id", "=", id);
const result = await query.execute();
await prisma.$kysely.deleteFrom("User").where("id", "=", id).execute();
Transactions
Prisma's interactive transactions are fully supported by prisma-extension-kysely
! Just remeber to use tx.$kysely
instead of prisma.$kysely
, and you're good to go:
await prisma.$transaction(async (tx) => {
await tx.$kysely
.insertInto("User")
.values({ id: 1, name: "John Doe" })
.execute();
await tx.$kysely
.insertInto("User")
.values({ id: 2, name: "Jane Doe" })
.execute();
});
Don't try to use Kysely's transaction
method directly, though. It's not supported by prisma-extension-kysely
, and it will throw an error if you try to use it.
await prisma.$kysely.transaction().execute(async (trx) => {});
Plugins
Do you love Kysely's plugins? So do we! You can use them with prisma-extension-kysely
as well:
const prisma = new PrismaClient().$extends(
kyselyExtension({
kysely: (driver) =>
new Kysely<DB>({
dialect: {
createDriver: () => driver,
createAdapter: () => new PostgresAdapter(),
createIntrospector: (db) => new PostgresIntrospector(db),
createQueryCompiler: () => new PostgresQueryCompiler(),
},
plugins: [new CamelCasePlugin()],
}),
}),
);
If you're using the CamelCasePlugin
, don't forget to add the camelCase
option to your Prisma schema too:
generator kysely {
provider = "prisma-kysely"
camelCase = true
}
Take a look at the camel case example to see it in action! Check out the Kysely documentation for more information about plugins.
Examples
Check out the examples directory for a sample project!
cd examples/basic
npm install
npx prisma db push
npm run dev
Learn more
License
This project is licensed under the MIT License - see the LICENSE file for details.