Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion content/250-postgres/350-integrations/200-vercel.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ These enable you to connect to the Prisma Postgres instances via any ORM or data
The easiest way to use Prisma Postgres on the Vercel Marketplace is via one of the templates:

- [Prisma ORM + NextAuth Starter](https://vercel.com/templates/next.js/prisma-postgres)
- [Postgres + Nuxt Starter](https://vercel.com/templates/nuxt/postgres-nuxt)
- [Postgres + Kysely Next.js Starter](https://vercel.com/templates/next.js/postgres-kysely)
- [Postgres + Drizzle Next.js Starter](https://vercel.com/templates/next.js/postgres-drizzle)
- [Postgres + SvelteKit Starter](https://vercel.com/templates/svelte/postgres-sveltekit)
Expand Down
356 changes: 356 additions & 0 deletions content/800-guides/460-bun-workspaces.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,356 @@
---
title: 'How to use Prisma ORM and Prisma Postgres in a Bun workspaces monorepo'
metaTitle: 'How to use Prisma ORM and Prisma Postgres in a Bun workspaces monorepo'
description: 'Learn step-by-step how to integrate Prisma ORM in a Bun workspaces monorepo to build scalable and modular applications efficiently.'
sidebar_label: 'Bun workspaces'
image: '/img/guides/prisma-bun-workspaces-cover.png'
completion_time: '10 min'
community_section: true
---

## Introduction

This guide shows you how to use Prisma ORM in a [Bun Workspaces](https://bun.sh/docs/install/workspaces) monorepo. You'll set up a shared database package with Prisma ORM, then integrate it into a Next.js app in the same workspace.

## Prerequisites

- [Bun](https://bun.sh/docs/installation) installed
- A [Prisma Postgres](/postgres) database (or another [supported database](/orm/reference/supported-databases))

## 1. Set up project

Before integrating Prisma ORM, you need to set up your project structure. Start by creating a new directory for your project (for example, `my-monorepo`) and initialize a Node.js project:

```bash
mkdir my-monorepo
cd my-monorepo
bun init -y
```

This creates a basic Bun project that includes a `package.json` file and an `index.ts` file.

Next, add the `workspaces` array to your root `package.json` to define your workspace structure:

```json file=package.json
{
// add-start
"name": "my-monorepo",
"workspaces": ["apps/*", "packages/*"]
// add-end
}
```

Finally, create directories for your applications and shared packages:

```bash
mkdir apps
mkdir -p packages/database
```

## 2. Set up database package

This section covers creating a standalone database package that uses Prisma ORM. The package will house all database models and the generated Prisma ORM client, making it reusable across your monorepo.

### 2.1. Install dependencies

Navigate to the `packages/database` directory and initialize a new package:

```bash
cd packages/database
bun init
```

Install the required Prisma ORM packages and other dependencies:

```bash
bun add -d prisma typescript tsx @types/node @types/pg
bun add @prisma/client @prisma/adapter-pg pg
```

:::info

If you are using a different database provider (MySQL, SQL Server, SQLite), install the corresponding driver adapter package instead of `@prisma/adapter-pg`. For more information, see [Database drivers](/orm/overview/databases/database-drivers).

:::

### 2.2. Set up Prisma ORM and schema

Initialize Prisma ORM with an instance of [Prisma Postgres](/postgres) in the `database` package by running the following command:

```bash
bunx prisma init --db
```

Enter a name for your project and choose a database region.

:::info

We're going to be using [Prisma Postgres](/getting-started/prisma-postgres) in this guide. If you're not using a Prisma Postgres database, you won't need to add the `--db` flag.

:::

This command:

- Connects your CLI to your [Prisma Data Platform](https://console.prisma.io) account. If you're not logged in or don't have an account, your browser will open to guide you through creating a new account or signing into your existing one.
- Creates a `prisma` directory containing a `schema.prisma` file for your database models.
- Creates a `prisma.config.ts` file (which uses `process.env["DATABASE_URL"]` and expects `dotenv`).
- Creates a `.env` file with your `DATABASE_URL` (e.g., for Prisma Postgres it should have something similar to `DATABASE_URL="prisma+postgres://accelerate.prisma-data.net/?api_key=eyJhbGciOiJIUzI..."`).
Comment on lines +94 to +97
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

cat -n content/800-guides/460-bun-workspaces.mdx | sed -n '85,105p'

Repository: prisma/docs

Length of output: 1292


🌐 Web query:

Prisma v7 prisma init --db generated prisma.config.ts template

💡 Result:

If you run Prisma ORM v7+:

npx prisma@latest init --db

…it will create prisma.config.ts (plus prisma/schema.prisma, etc.). If --db “is not recognized”, it’s usually npx caching—use npx prisma@latest init --db explicitly. [3]

Typical prisma.config.ts template (Node)

This is the shape Prisma expects (and matches what Prisma’s guides show after init --db):

import "dotenv/config";
import { defineConfig, env } from "prisma/config";

export default defineConfig({
  schema: "prisma/schema.prisma",
  migrations: {
    path: "prisma/migrations",
  },
  // (you may see engine in some templates/guides)
  engine: "classic",
  datasource: {
    url: env("DATABASE_URL"),
  },
});

Prisma config files support prisma.config.ts (and other extensions/locations), and .env is not auto-loaded when using prisma.config.ts—so importing dotenv/config (in Node) is the common fix. [4][5][2]

Note on Bun vs Node

As of Prisma ORM 7.2.0 (Dec 17, 2025), prisma init generates runtime-specific config output (e.g., it won’t assume dotenv is needed for Bun). [1]

Sources: Prisma ORM 7.2.0 announcement [1], Prisma “React Router 7” guide showing init --db + config example [2], Prisma docs troubleshooting for --db not recognized / npx caching [3], Prisma config reference (file names + .env loading behavior) [4], Prisma config patterns (defineConfig, env()) [5].


Update the prisma.config.ts description to match Prisma v7's actual generated template.

The generated file uses env("DATABASE_URL") from the prisma/config module (not process.env), and it explicitly imports "dotenv/config" rather than simply "expecting" it. Update line 96 to:

- Creates a `prisma.config.ts` file (which uses `process.env["DATABASE_URL"]` and expects `dotenv`).
+ Creates a `prisma.config.ts` file (which uses `env("DATABASE_URL")` from `prisma/config` and includes `import "dotenv/config"`).

This matches the actual template generated by prisma init --db in Prisma v7.

🤖 Prompt for AI Agents
In `@content/800-guides/460-bun-workspaces.mdx` around lines 94 - 97, Update the
description for prisma.config.ts to reflect Prisma v7's generated template:
state that the file imports "dotenv/config" and uses env("DATABASE_URL") from
the prisma/config module (not process.env), replacing the prior claim that it
"uses process.env and expects dotenv"; reference prisma.config.ts, the
env("DATABASE_URL") call, and the "dotenv/config" import so the text matches the
actual output of prisma init --db.


Edit the `schema.prisma` file to add a `User` model. The default generator already sets `output = "../generated/prisma"`:

```prisma file=prisma/schema.prisma
generator client {
provider = "prisma-client"
output = "../generated/prisma"
}

datasource db {
provider = "postgresql"
}

// add-start
model User {
id Int @id @default(autoincrement())
email String @unique
name String?
}
// add-end
```

If the generated `prisma.config.ts` comments mention installing `dotenv`, install it so environment variables load:

```bash
bun add dotenv
```

Add a `scripts` section to your database `package.json` (Bun init may not add one by default):

```json file=database/package.json
{
// add-start
"scripts": {
"db:generate": "prisma generate",
"db:migrate": "prisma migrate dev",
"db:deploy": "prisma migrate deploy",
"db:seed": "prisma db seed",
"db:studio": "prisma studio"
}
// add-end
}
```

Use [Prisma Migrate](/orm/prisma-migrate) to migrate your database changes:

```bash
bun run db:migrate
```

When prompted by the CLI, enter a descriptive name for your migration. After the migration completes, run generate so the Prisma ORM client is created:

```bash
bun run db:generate
```

Create a `client.ts` file to initialize the Prisma ORM client with a driver adapter:

```ts file=database/client.ts
import { PrismaClient } from "./generated/prisma/client";
import { PrismaPg } from "@prisma/adapter-pg";

const adapter = new PrismaPg({
connectionString: process.env.DATABASE_URL,
});

// Use globalThis for broader environment compatibility
const globalForPrisma = globalThis as typeof globalThis & {
prisma?: PrismaClient;
};

export const prisma: PrismaClient =
globalForPrisma.prisma ??
new PrismaClient({
adapter,
});

if (process.env.NODE_ENV !== "production") {
globalForPrisma.prisma = prisma;
}
```

Then, create an `index.ts` file to re-export the instance of the Prisma ORM client and all generated types:

```ts file=database/index.ts
export { prisma } from "./client";
export * from "./generated/prisma/client";
```

### 2.3. Seed the database

Add a seed script to populate the database with sample users. Create `prisma/seed.ts` in the database package:

```ts file=database/prisma/seed.ts
import "dotenv/config";
import { PrismaClient } from "../generated/prisma/client";
import { PrismaPg } from "@prisma/adapter-pg";

const adapter = new PrismaPg({
connectionString: process.env.DATABASE_URL!,
});

const prisma = new PrismaClient({ adapter });

async function main() {
await prisma.user.createMany({
data: [
{ email: "alice@example.com", name: "Alice" },
{ email: "bob@example.com", name: "Bob" },
{ email: "charlie@example.com", name: "Charlie" },
],
skipDuplicates: true,
});
console.log("Seed complete.");
}

main()
.catch((e) => {
console.error(e);
process.exit(1);
})
.finally(async () => {
await prisma.$disconnect();
});
```

Add the `seed` option to the existing `migrations` config in your database package's `prisma.config.ts` (add the `seed` line inside `migrations`):

```ts file=database/prisma.config.ts
migrations: {
path: "prisma/migrations",
// add-start
seed: "bun prisma/seed.ts",
// add-end
},
```

At this point, your shared database package is fully configured and ready for use across your monorepo.

### 2.4. Add root scripts

Add the following scripts to the root `package.json` of your monorepo. They let you run database and app commands from the root:

```json file=package.json
{
// add-start
"scripts": {
"build": "bun run --filter database db:deploy && bun run --filter database db:generate && bun run --filter web build",
"start": "bun run --filter web start",
"dev": "bun run --filter database db:generate && bun run --filter web dev",
"seed": "bun run --filter database db:seed",
"studio": "bun run --filter database db:studio"
}
// add-end
}
```

From the monorepo root, run `bun run seed` to add sample users. Run `bun run studio` to open [Prisma Studio](/postgres/database/prisma-studio) at [`http://localhost:5555`](http://localhost:5555) to view and edit your data.

## 3. Set up Next.js app

Now that the database package is set up, create a frontend application (using Next.js) that uses the shared Prisma ORM client to interact with your database.

### 3.1. Create Next.js app

Navigate to the `apps` directory:

```bash
cd ../../apps
```

Create a new Next.js app named `web`:

```bash
bun create next-app@latest web --yes
```

:::note[important]

The `--yes` flag uses default configurations to bootstrap the Next.js app (which in this guide uses the app router without a `src/` directory). When prompted for a package manager, choose **Bun** so the app uses Bun within the workspace.

Additionally, the flag may automatically initialize a Git repository in the `web` folder. If that happens, please remove the `.git` directory by running `rm -r .git`.

:::

Then, navigate into the web directory:

```bash
cd web/
```

Copy the `.env` file from the database package to ensure the same environment variables are available:

```bash
cp ../../packages/database/.env .
```

Open the `package.json` file of your Next.js app and add the shared `database` package as a dependency:

```json file=web/package.json
"dependencies": {
// add-start
"database": "workspace:*"
// add-end
}
```

Run the following command to install the `database` package:

```bash
bun install
```

### 3.2. Add database to app

Modify your Next.js application code to use the Prisma ORM client from the database package. Update `app/page.tsx` as follows:

```tsx file=app/page.tsx
import { prisma } from "database";

export default async function Home() {
const user = await prisma.user.findFirst({
select: {
name: true,
},
});

return (
<div>
{user?.name && <p>Hello from {user.name}</p>}
{!user?.name && <p>No user has been added to the database yet.</p>}
</div>
);
}
```

This code demonstrates importing and using the shared Prisma ORM client to query your `User` model.

### 3.3. Run the app

Then head back to the root of the monorepo:

```bash
cd ../../
```

Start your development server by executing:

```bash
bun run dev
```

Open your browser at [`http://localhost:3000`](http://localhost:3000) to see your app in action. You can run `bun run studio` to open [Prisma Studio](/postgres/database/prisma-studio) at [`http://localhost:5555`](http://localhost:5555) to view and edit your data.

## Next steps

You have now created a monorepo that uses Prisma ORM, with a shared database package integrated into a Next.js application.

For further exploration and to enhance your setup, consider reading the [How to use Prisma ORM with Turborepo](/guides/turborepo) guide.
1 change: 1 addition & 0 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -391,6 +391,7 @@ const sidebars: SidebarsConfig = {
"guides/cloudflare-workers",
"guides/docker",
"guides/use-prisma-in-pnpm-workspaces",
"guides/bun-workspaces",
"guides/data-dog",
"guides/github-actions",
"guides/bun",
Expand Down
Binary file added static/img/guides/prisma-bun-workspaces-cover.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.