bun-types

--- name: Use Prisma with Bun --- {% callout %} **Note** — At the moment Prisma needs Node.js to be installed to run certain generation code. Make sure Node.js is installed in the environment where you're running `bunx prisma` commands. {% /callout %} --- Prisma works out of the box with Bun. First, create a directory and initialize it with `bun init`. ```bash $ mkdir prisma-app $ cd prisma-app $ bun init ``` --- Then install the Prisma CLI (`prisma`) and Prisma Client (`@prisma/client`) as dependencies. ```bash $ bun add -d prisma $ bun add @prisma/client ``` --- We'll use the Prisma CLI with `bunx` to initialize our schema and migration directory. For simplicity we'll be using an in-memory SQLite database. ```bash $ bunx prisma init --datasource-provider sqlite ``` --- Open `prisma/schema.prisma` and add a simple `User` model. ```prisma-diff#prisma/schema.prisma generator client { provider = "prisma-client-js" } datasource db { provider = "sqlite" url = env("DATABASE_URL") } + model User { + id Int @id @default(autoincrement()) + email String @unique + name String? + } ``` --- Then generate and run initial migration. This will generate a `.sql` migration file in `prisma/migrations`, create a new SQLite instance, and execute the migration against the new instance. ```bash $ bunx prisma migrate dev --name init Environment variables loaded from .env Prisma schema loaded from prisma/schema.prisma Datasource "db": SQLite database "dev.db" at "file:./dev.db" SQLite database dev.db created at file:./dev.db Applying migration `20230928182242_init` The following migration(s) have been created and applied from new schema changes: migrations/ └─ 20230928182242_init/ └─ migration.sql Your database is now in sync with your schema. ✔ Generated Prisma Client (v5.3.1) to ./node_modules/@prisma/client in 41ms ``` --- As indicated in the output, Prisma re-generates our _Prisma client_ whenever we execute a new migration. The client provides a fully typed API for reading and writing from our database. You can manually re-generate the client with the Prisma CLI. ```sh $ bunx prisma generate ``` --- We can import the generated client from `@prisma/client`. ```ts#src/index.ts import {PrismaClient} from "@prisma/client"; ``` --- Let's write a simple script to create a new user, then count the number of users in the database. ```ts#index.ts import { PrismaClient } from "@prisma/client"; const prisma = new PrismaClient(); // create a new user await prisma.user.create({ data: { name: "John Dough", email: `john-${Math.random()}@example.com`, }, }); // count the number of users const count = await prisma.user.count(); console.log(`There are ${count} users in the database.`); ``` --- Let's run this script with `bun run`. Each time we run it, a new user is created. ```bash $ bun run index.ts Created john-0.12802932895402364@example.com There are 1 users in the database. $ bun run index.ts Created john-0.8671308799782803@example.com There are 2 users in the database. $ bun run index.ts Created john-0.4465968383115295@example.com There are 3 users in the database. ``` --- That's it! Now that you've set up Prisma using Bun, we recommend referring to the [official Prisma docs](https://www.prisma.io/docs/concepts/components/prisma-client) as you continue to develop your application.