Prisma

https://www.prisma.io/docs
Admin
Prisma is a TypeScript ORM that provides a declarative database migration system, type-safe database...
Tokens:2,018,395
Snippets:19,090
Trust Score:9.9
Update:1 day ago
Show doc for...
Tokens:
Raw
### Navigate, install dependencies, and start dev server

Source: https://www.prisma.io/docs/guides/v7/frameworks/solid-start

Run these commands to navigate into your new project, install dependencies, and start the development server.

```bash
cd my-solid-prisma-app
bun install
bun run dev
```

--------------------------------

### Output of bun install

Source: https://www.prisma.io/docs/guides/deployment/bun-workspaces

Example output showing the installation summary.

```text
bun install v1.3.3 (274e01c7)
Saved lockfile

Checked 478 installs across 616 packages (no changes) [440.00ms]
```

--------------------------------

### Download Prisma on Koyeb example and install dependencies

Source: https://www.prisma.io/docs/orm/v6/prisma-client/deployment/traditional/deploy-to-koyeb

Run these commands in your terminal to create a project directory, download the example code, and install npm dependencies. The tree command verifies the expected file structure.

```bash
mkdir prisma-on-koyeb
cd prisma-on-koyeb
curl https://github.com/koyeb/example-prisma/tarball/main/latest | tar xz  --strip=1
```

```bash
npm install
```

--------------------------------

### Install prisma-extension-find-or-create with bun

Source: https://www.prisma.io/docs/orm/v6/prisma-client/client-extensions/shared-extensions

Example command to install the prisma-extension-find-or-create package using bun.

```bash
bun add prisma-extension-find-or-create
```

--------------------------------

### Download Prisma Heroku example and install dependencies

Source: https://www.prisma.io/docs/orm/v6/prisma-client/deployment/traditional/deploy-to-heroku

Run these commands in your terminal to create a project directory, download the example code, and install dependencies. The checkpoint verifies the expected files are present.

```bash
mkdir prisma-heroku
cd prisma-heroku
curl https://codeload.github.com/prisma/prisma-examples/tar.gz/latest | tar -xz --strip=3 prisma-examples-latest/deployment-platforms/heroku
```

```bash
ls -1
Procfile
README.md
package.json
prisma
public
src
```

```bash
npm install
```

--------------------------------

### Install fx and sign in

Source: https://www.prisma.io/docs/ai/tools/mcp-server

Run these commands to install fx via the setup script and then log in. Use this before configuring MCP servers.

```bash
curl -fsSL https://fx.sh/setup.sh | bash
fx login
```

--------------------------------

### Navigate to the project directory

Source: https://www.prisma.io/docs/guides/authentication/better-auth/astro

Change into the newly created project directory to continue setup.

```bash
cd betterauth-astro-prisma
```

--------------------------------

### Prisma init examples with bun

Source: https://www.prisma.io/docs/cli/init

Examples of running prisma init with bun, including specifying agents for skills and skipping the postinstall hook.

```bash
bunx --bun prisma@latest init
bunx --bun prisma@latest init --skills=claude,cursor
bunx --bun prisma@latest init --skills=none
bunx --bun prisma@latest init --no-postinstall
```

--------------------------------

### curl GET /posts

Source: https://www.prisma.io/docs/guides/switch-to-prisma-orm/from-mongoose

Test the GET /posts endpoint after starting the server.

```bash
curl http://localhost:3000/posts
```

--------------------------------

### List databases in sqlcmd

Source: https://www.prisma.io/docs/orm/v6/overview/databases/sql-server/sql-server-docker

Run this from the sqlcmd command prompt to verify that the quickstart database was created successfully.

```sql
sp_databases
GO
```

--------------------------------

### cURL example for GET /v1/workspaces

Source: https://www.prisma.io/docs/rest-api/endpoints/workspaces/get-workspaces

Example cURL request to retrieve the list of workspaces.

```bash
curl -X GET "https://example.com/v1/workspaces"
```

--------------------------------

### Create a new database in sqlcmd

Source: https://www.prisma.io/docs/orm/v6/overview/databases/sql-server/sql-server-docker

Run this from the sqlcmd command prompt to create a database named quickstart.

```sql
CREATE DATABASE quickstart
GO
```

--------------------------------

### cURL example for GET /v1/regions

Source: https://www.prisma.io/docs/rest-api/endpoints/regions/get-regions

Example request to retrieve all regions using cURL.

```bash
curl -X GET "https://example.com/v1/regions"
```

--------------------------------

### Deploy output example

Source: https://www.prisma.io/docs/guides/authentication/clerk/nextjs

Example output from the deploy command, showing the created project, database, and app service with its URL.

```text
clerk-nextjs-prisma
├─ database   postgres-database db_abc123
└─ app        compute-service cps_abc123
              https://xyz.ewr.prisma.build
```

--------------------------------

### Mongoose GET /users response example

Source: https://www.prisma.io/docs/guides/switch-to-prisma-orm/from-mongoose

Example JSON response from the Mongoose server's GET /users endpoint, showing two user documents with nested profile and MongoDB-specific fields. Use this to compare with the Prisma ORM version.

```json
[{"profile":{"bio":"Writes about databases"},"_id":"6aa2cd2ed97f8d7357dc9bd1","email":"alice@prisma.io","name":"Alice","__v":0},{"_id":"6aa2cd2ed97f8d7357dc9bd2","email":"bob@prisma.io","name":"Bob","__v":0}]
```

--------------------------------

### Example .env file with DATABASE_URL

Source: https://www.prisma.io/docs/orm/v6/prisma-client/setup-and-configuration/generating-prisma-client

Create a .env file in the project root and add the database connection string as DATABASE_URL.

```text
DATABASE_URL="your_database_connection_string_here"
```

--------------------------------

### Navigate to the app directory

Source: https://www.prisma.io/docs/guides/integrations/shopify

Change into the newly created app directory to proceed with setup.

```bash
cd prisma-store
```

--------------------------------

### Start development server with bun

Source: https://www.prisma.io/docs/ai/tutorials/linktree-clone

Run this command to start the Next.js development server using bun. Use it to verify the project setup.

```bash
bun run dev
```

--------------------------------

### Install @prisma/adapter-planetscale (bun)

Source: https://www.prisma.io/docs/orm/v6/prisma-client/deployment/edge/deploy-to-cloudflare

Install the PlanetScale adapter package required for Prisma Client to connect to PlanetScale from Cloudflare Workers. This example uses bun.

```bash
bun add @prisma/adapter-planetscale@6.19.3
```

--------------------------------

### Set up Prisma ORM 8 in a new project

Source: https://www.prisma.io/docs/orm/coming-from-prisma-orm-7

Install prisma and @prisma/orm-postgres, then run orm init to write prisma.config.ts, a starter src/prisma/contract.prisma, src/prisma/db.ts, and .env. Put your connection string in .env as DATABASE_URL, write your models in the contract, and run npx prisma contract emit.

```bash
bun add --dev prisma
bun add @prisma/orm-postgres
bunx prisma orm init --write-env
```

--------------------------------

### Install Prisma and Dependencies

Source: https://www.prisma.io/docs/ai/prompts/nextjs

Install Prisma, tsx, and the PostgreSQL adapter along with the Prisma client and dotenv. These commands are part of the initial setup workflow.

```npm
npm install prisma@prev tsx --save-dev
```

```npm
npm install @prisma/adapter-pg @prisma/client@7 dotenv
```

--------------------------------

### cURL example for GET /v1/projects/{projectId}/databases

Source: https://www.prisma.io/docs/rest-api/endpoints/databases/get-projects-by-project-id-databases

Sends a GET request to retrieve databases for a project. Replace the project ID and base URL as needed.

```bash
curl -X GET "https://example.com/v1/projects/string/databases"
```

--------------------------------

### cURL example for GET /v1/me

Source: https://www.prisma.io/docs/rest-api/endpoints/misc/get-me

Sends a GET request to retrieve the current authenticated principal. Requires OAuth2 authentication with workspace:admin and offline_access scopes.

```bash
curl -X GET "https://example.com/v1/me"
```

--------------------------------

### Apply the starter contract and sign the database

Source: https://www.prisma.io/docs/guides/runtimes/deno

Apply the starter contract and sign the database using the db:init task.

```bash
deno task db:init
```

--------------------------------

### Navigate into project and start dev server with bun

Source: https://www.prisma.io/docs/guides/v7/frameworks/sveltekit

After scaffolding, change into the project directory and run the development server using bun.

```bash
cd sveltekit-prisma
bun run dev
```

--------------------------------

### Get list of integrations response

Source: https://www.prisma.io/docs/rest-api/endpoints/integrations/get-integrations

Example 200 response body for the GET /v1/integrations endpoint. The response includes a data array of integrations and pagination information.

```json
{
  "data": [
    {
      "id": "string",
      "url": "http://example.com",
      "createdAt": "2019-08-24T14:15:22Z",
      "scopes": [
        "string"
      ],
      "client": {
        "id": "string",
        "name": "string",
        "createdAt": "2019-08-24T14:15:22Z"
      },
      "createdByUser": {
        "id": "string",
        "email": "string",
        "displayName": "string"
      }
    }
  ],
  "pagination": {
    "nextCursor": "string",
    "hasMore": true
  }
}
```

--------------------------------

### Install @prisma/client@6.13.0 with bun

Source: https://www.prisma.io/docs/orm/v6/prisma-client/observability-and-logging/metrics

Installs the Prisma Client version 6.13.0 using bun. This is part of the prerequisite setup for using Prisma Client metrics.

```bash
bun add @prisma/client@6.13.0
```

--------------------------------

### Add an example model

Source: https://www.prisma.io/docs/cli/v7/init

Set up a project with an example `User` model. Use this to include a sample model in the generated schema.

```shell
bunx --bun prisma init --with-model
```

--------------------------------

### Example deployment output

Source: https://www.prisma.io/docs/prisma-compute/deploy

After a successful deploy, the CLI prints the project name, each service, the platform resource it became, and its public URL.

```text
my-app
└─ web   compute-service cps_abc123
         https://xyz.ewr.prisma.build
```

--------------------------------

### Guide template frontmatter and structure

Source: https://www.prisma.io/docs/guides/making-guides

Use this template as a starting point for a new guide. It includes frontmatter, prerequisites, step-by-step instructions, common gotchas, and agent prompts.

```markdown
---
title: '[Your guide title]'
description: '[One sentence: what the reader builds]'
url: /guides/[category]/[slug]
metaTitle: How to use Prisma ORM with [Topic]
metaDescription: '[One sentence for search results]'
---

## Introduction

[What this guide builds and what the reader ends up with. Two or three sentences.]

:::note[Using Prisma ORM 7?]

Prisma ORM 8 is a [release candidate](/orm/release-status). Prisma ORM 7 remains fully supported; the Prisma ORM 7 version of this guide is at [/guides/v7/[category]/[slug]](/guides/v7/[category]/[slug]).

:::

## Prerequisites

- [Node.js](https://nodejs.org) 22.18 or newer on the 22 line, 24.11 or newer on the 24 line, or 26 or newer (24 recommended)
- A PostgreSQL connection string, or nothing at all: `npx create-db@latest` creates a [Prisma Postgres](/postgres) database for you

## 1. Set up the project

```npm
[Framework scaffold command]
```

## 2. Add Prisma ORM

```npm
npx prisma@latest orm init --target postgres
```

```text no-copy
[Trimmed real output]
```

Set the connection string:

```bash title=".env"
DATABASE_URL="postgresql://user:password@localhost:5432/mydb"
```

## 3. Define the contract

```prisma title="src/prisma/contract.prisma"
[Your models]
```

```npm
npx prisma contract emit
```

## 4. Initialize the database

```npm
npx prisma db init
```

```text no-copy
"summary": "Applied N operation(s) across 1 space(s), database signed"
```

## 5. [Integration-specific steps]

[Framework or platform steps, each with its command and real output]

## Common gotchas

[Failures you hit while validating, with the verbatim error and the fix]

## Use with your agent

To delegate this guide to your coding agent, copy the prompt below and hand it over:

<AgentPrompt>

```text
[Numbered instructions an agent can follow to complete this guide, referencing https://www.prisma.io/docs/guides/[category]/[slug].md]
```

</AgentPrompt>

Run [`npx prisma@latest init`](/cli/init) once to install the [Prisma ORM skills](/ai/tools/skills#available-skills-for-prisma-8) for your coding agent. Prompts that map to this guide:

- "[Prompt 1]"
- "[Prompt 2]"

## Next steps

- [Learn the fundamentals](/orm/fundamentals/reading-data): filtering, sorting, pagination, and writes.
- [Read the Prisma ORM overview](/orm) for the concepts behind contracts and typed queries.
```

--------------------------------

### Update category meta.json to add a guide

Source: https://www.prisma.io/docs/guides/making-guides

Add the guide's page name (the .mdx filename without extension) to the pages array in the category's meta.json. The example shows the frameworks category meta.json with a new guide entry.

```json
{
  "title": "Frameworks",
  "defaultOpen": true,
  "pages": [
    "nextjs",
    "astro",
    "nuxt",
    "your-new-guide"
  ]
}
```

--------------------------------

### Initialize a new project with bun

Source: https://www.prisma.io/docs/prisma-postgres/quickstart/kysely

Create a new directory and initialize a project using bun. This is the first step in setting up the Kysely quickstart.

```shell
mkdir kysely-quickstart
cd kysely-quickstart
bun init
```

--------------------------------

### Example Prisma Schema for MongoDB

Source: https://www.prisma.io/docs/orm/v6/prisma-schema/overview

A complete Prisma schema example for MongoDB, including a datasource, generator, two models with a relation, and an enum. Use this as a starting point for your own schema.

```prisma
datasource db {
  provider = "mongodb"
}

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

model User {
  id        String   @id @default(auto()) @map("_id") @db.ObjectId
  createdAt DateTime @default(now())
  email     String   @unique
  name      String?
  role      Role     @default(USER)
  posts     Post[]
}

model Post {
  id        String   @id @default(auto()) @map("_id") @db.ObjectId
  createdAt DateTime @default(now())
  updatedAt DateTime @updatedAt
  published Boolean  @default(false)
  title     String   @db.VarChar(255)
  author    User?    @relation(fields: [authorId], references: [id])
  authorId  String?  @db.ObjectId
}

enum Role {
  USER
  ADMIN
}
```

--------------------------------

### Initialize Git repository and commit initial setup

Source: https://www.prisma.io/docs/ai/tutorials/linktree-clone

Run these commands to initialize a Git repository, stage all files, and commit the initial setup. This is recommended for tracking progress.

```bash
git init
git add .
git commit -m "Initial setup: Next.js app with Prisma"
```

--------------------------------

### Example Prisma Schema for PostgreSQL

Source: https://www.prisma.io/docs/orm/v6/prisma-schema/overview

A complete Prisma schema example for PostgreSQL, including a datasource, generator, two models with a relation, and an enum. Use this as a starting point for your own schema.

```prisma
datasource db {
  provider = "postgresql"
}

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

model User {
  id        Int      @id @default(autoincrement())
  createdAt DateTime @default(now())
  email     String   @unique
  name      String?
  role      Role     @default(USER)
  posts     Post[]
}

model Post {
  id        Int      @id @default(autoincrement())
  createdAt DateTime @default(now())
  updatedAt DateTime @updatedAt
  published Boolean  @default(false)
  title     String   @db.VarChar(255)
  author    User?    @relation(fields: [authorId], references: [id])
  authorId  Int?
}

enum Role {
  USER
  ADMIN
}
```

--------------------------------

### Example database connection string output

Source: https://www.prisma.io/docs/guides/v7/frameworks/tanstack-start

After creating the project, the CLI displays the database connection string. This is an example of the output you will see.

```text
●  Database Connection
│
│    Connection String:
│
│    postgresql://username:password@db.prisma.io:5432/postgres
●
```

--------------------------------

### Navigate into web directory

Source: https://www.prisma.io/docs/guides/v7/deployment/bun-workspaces

Change into the newly created web directory to continue setup.

```bash
cd web/
```

--------------------------------

### Get workspace subscription response

Source: https://www.prisma.io/docs/rest-api/endpoints/workspaces/get-workspaces-by-id-subscription

Example 200 response body for the get workspace subscription endpoint. Contains plan name, usage blocked status, and upgrade URL.

```json
{
  "data": {
    "planName": "string",
    "usageBlocked": true,
    "upgradeUrl": "http://example.com"
  }
}
```

--------------------------------

### Output of bun run dev

Source: https://www.prisma.io/docs/guides/deployment/bun-workspaces

Example output showing the dev server starting.

```text
$ bun run --filter web dev
web dev: ▲ Next.js 16.3.4 (Turbopack)
web dev: - Local:         http://localhost:3000
web dev: - Network:       http://192.168.1.16:3000
web dev: - Environments: .env
web dev: ✓ Ready in 4.0s
```

--------------------------------

### Initialize a new Deno project

Source: https://www.prisma.io/docs/guides/integrations/deno

Use the `deno init` command to create a new Deno project with a basic structure. Then navigate into the project directory.

```bash
deno init prisma-postgres-deno-deploy
cd prisma-postgres-deno-deploy
```

--------------------------------

### Build and run locally with bun

Source: https://www.prisma.io/docs/composer/local-development

Build your app first, then run prisma dev. This example uses bun.

```bash
bun run build
bunx prisma dev module.ts
```

--------------------------------

### Create Dockerfile for Prisma app

Source: https://www.prisma.io/docs/guides/deployment/docker

Create a Dockerfile that installs dependencies, copies the application code, and runs migrations before starting the server. The CMD applies pending migrations and then starts the app.

```dockerfile
FROM node:24-alpine

WORKDIR /usr/src/app

COPY package.json package-lock.json ./

RUN npm ci

COPY . .

CMD ["sh", "-c", "npm run db:migrate && npm start"]
```

--------------------------------

### Install Prisma ORM with bun

Source: https://www.prisma.io/docs/guides/upgrade-prisma-orm/v1

Initialize a new project and install Prisma ORM and Prisma Client using bun. This sets up the necessary dependencies for the upgrade.

```bash
# Initialize a new project
bun init
bun add prisma@prev @prisma/client@7

# Initialize Prisma
bunx --bun prisma init
```

--------------------------------

### SQL queries generated by n+1 problem

Source: https://www.prisma.io/docs/orm/v6/prisma-client/queries/query-optimization-performance

This shows the SQL queries generated by the n+1 example: one query to get all users, followed by multiple queries to get posts for each user.

```sql
SELECT "public"."User"."id", "public"."User"."email", "public"."User"."name" FROM "public"."User" WHERE 1=1 OFFSET $1
SELECT "public"."Post"."id", "public"."Post"."title" FROM "public"."Post" WHERE "public"."Post"."authorId" = $1 OFFSET $2
SELECT "public"."Post"."id", "public"."Post"."title" FROM "public"."Post" WHERE "public"."Post"."authorId" = $1 OFFSET $2
SELECT "public"."Post"."id", "public"."Post"."title" FROM "public"."Post" WHERE "public"."Post"."authorId" = $1 OFFSET $2
SELECT "public"."Post"."id", "public"."Post"."title" FROM "public"."Post" WHERE "public"."Post"."authorId" = $1 OFFSET $2
/* ..and so on .. */
```
Tokens:
Raw