Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
prisma-extension-kysely2
Advanced tools
Readme
My target just want to use native kysely transaction and extend client without any args
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-kysely2
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-kysely2
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
kysely
kysely
queries with Prisma as if they were nativeClick the Use this template button and provide details for your Client extension
Install the dependencies:
npm install prisma-extension-kysely2 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 prismaKysely from "prisma-extension-kysely2";
import type { DB } from "./prisma/generated/types";
// Default with types
const prisma = new PrismaClient().$extends(prismaKysely<DB>());
// Custom dialect,plugins,options
const prisma = new PrismaClient().$extends(
prismaKysely({
dialect: {
// This is where the magic happens!
createDriver: () => driver,
// Don't forget to customize these to match your database!
createAdapter: () => new PostgresAdapter(),
createIntrospector: (db) => new PostgresIntrospector(db),
createQueryCompiler: () => new PostgresQueryCompiler(),
},
plugins: [
// Add your favorite plugins here!
],
}),
);
It's that simple! Now you can write raw SQL queries with kysely
and use them with Prisma:
// Replace this...
const result = prisma.$queryRaw`SELECT * FROM User WHERE id = ${id}`;
// With this!
const query = prisma.$kysely
.selectFrom("User")
.selectAll()
.where("id", "=", id);
// Thanks to kysely's magic, everything is type-safe!
const result = await query.execute();
// You can also execute queries without fetching the results
await prisma.$kysely.deleteFrom("User").where("id", "=", id).execute();
Prisma's interactive transactions are fully supported by prisma-extension-kysely2
! Just remeber to use tx.$kysely
instead of prisma.$kysely
, and you're good to go:
await prisma.$kysely.transaction().execute(async (trx) => {});
// Can use both
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();
});
Do you love Kysely's plugins? So do we! You can use them with prisma-extension-kysely2
as well:
const prisma = new PrismaClient().$extends(
prismaKysely<DB>({
dialect: {
createDriver: () => driver,
createAdapter: () => new PostgresAdapter(),
createIntrospector: (db) => new PostgresIntrospector(db),
createQueryCompiler: () => new PostgresQueryCompiler(),
},
// Use your favorite plugins!
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.
Check out the examples directory for a sample project!
cd examples/basic
npm install
npx prisma db push
npm run dev
This project is licensed under the MIT License - see the LICENSE file for details.
FAQs
Prisma extension for Kysely
The npm package prisma-extension-kysely2 receives a total of 268 weekly downloads. As such, prisma-extension-kysely2 popularity was classified as not popular.
We found that prisma-extension-kysely2 demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.