Introduction to Prisma Client
Prisma Client is an auto-generated and type-safe query builder that's tailored to your data. To get started with Prisma Client, follow the Quickstart.
In order to set up Prisma Client, you need a Prisma Config and a Prisma schema file:
import 'dotenv/config';
import { defineConfig, env } from 'prisma/config';
export default defineConfig({
schema: 'prisma/schema.prisma',
datasource: {
url: env('DATABASE_URL'),
},
});datasource db {
provider = "postgresql"
}
generator client {
provider = "prisma-client"
output = "../src/generated/prisma"
}
model User {
id Int @id @default(autoincrement())
createdAt DateTime @default(now())
email String @unique
name String?
}Install the Prisma CLI, the Prisma Client library, and the driver adapter for your database:
bun add prisma@prev --dev
bun add @prisma/client@7 @prisma/adapter-pg pgpnpm add prisma@prev --save-dev
pnpm add @prisma/client@7 @prisma/adapter-pg pgyarn add prisma@prev --dev
yarn add @prisma/client@7 @prisma/adapter-pg pgnpm install prisma@prev --save-dev
npm install @prisma/client@7 @prisma/adapter-pg pg bun add prisma@prev --dev
bun add @prisma/client@7 @prisma/adapter-mariadb mariadb
``` bun add prisma@prev --dev
bun add @prisma/client@7 @prisma/adapter-better-sqlite3 better-sqlite3
```Generate the Client API {#generate-the-client-api}
Section titled “Generate the Client API {#generate-the-client-api}”Prisma Client is based on the models in Prisma Schema. To provide the correct types, you need generate the client code:
bunx prisma generatepnpm add prisma@prev --save-dev
pnpm add @prisma/client@7 @prisma/adapter-mariadb mariadbyarn add prisma@prev --dev
yarn add @prisma/client@7 @prisma/adapter-mariadb mariadbnpm install prisma@prev --save-dev
npm install @prisma/client@7 @prisma/adapter-mariadb mariadbThis will create a generated directory based on where you set the output to in the Prisma Schema. Any time your import Prisma Client, it will need to come from this generated client API.
With the client generated, import it along with your driver adapter and create a new instance:
import { PrismaClient } from "./path/to/generated/prisma";
import { PrismaPg } from "@prisma/adapter-pg";
const adapter = new PrismaPg({
connectionString: process.env.DATABASE_URL!,
});
export const prisma = new PrismaClient({ adapter });import { PrismaClient } from "./path/to/generated/prisma";
import { PrismaMariaDb } from "@prisma/adapter-mariadb";
const adapter = new PrismaMariaDb({
host: "localhost",
user: "root",
database: "mydb",
});
export const prisma = new PrismaClient({ adapter });import { PrismaClient } from "./path/to/generated/prisma";
import { PrismaBetterSqlite3 } from "@prisma/adapter-better-sqlite3";
const adapter = new PrismaBetterSqlite3({
url: "file:./dev.db",
});
export const prisma = new PrismaClient({ adapter });import { PrismaClient } from "./path/to/generated/prisma/edge";
import { PrismaPostgresAdapter } from "@prisma/adapter-ppg";
const adapter = new PrismaPostgresAdapter({
connectionString: process.env.DATABASE_URL!,
});
export const prisma = new PrismaClient({ adapter });[!WARNING]
PrismaClientrequires a driver adapter in Prisma 7. Callingnew PrismaClient()without anadapterwill result in an error.
Find out what driver adapter is needed for your database.
Your application should generally only create one instance of PrismaClient. How to achieve this depends on whether you are using Prisma ORM in a long-running application or in a serverless environment.
Creating multiple instances of PrismaClient will create multiple connection pools and can hit the connection limit for your database. Too many connections may start to slow down your database and eventually lead to errors such as:
Error in connector: Error querying the database: db error: FATAL: sorry, too many clients already
at PrismaClientFetcher.requestFind out what driver adapter is needed for your database.
Your application should generally only create one instance of PrismaClient. How to achieve this depends on whether you are using Prisma ORM in a long-running application or in a serverless environment.
Creating multiple instances of PrismaClient will create multiple connection pools and can hit the connection limit for your database. Too many connections may start to slow down your database and eventually lead to errors such as:
Error in connector: Error querying the database: db error: FATAL: sorry, too many clients already
at PrismaClientFetcher.requestUse Prisma Client to send queries to your database
Section titled “Use Prisma Client to send queries to your database”Once you have instantiated PrismaClient, you can start sending queries in your code:
// run inside `async` function
const newUser = await prisma.user.create({
data: {
name: "Alice",
email: "alice@prisma.io",
},
});
const users = await prisma.user.findMany();Whenever you make changes to your database that are reflected in the Prisma schema, you need to manually re-generate Prisma Client to update the generated code in your output directory:
bunx prisma generatepnpm add prisma@prev --save-dev
pnpm add @prisma/client@7 @prisma/adapter-better-sqlite3 better-sqlite3yarn add prisma@prev --dev
yarn add @prisma/client@7 @prisma/adapter-better-sqlite3 better-sqlite3npm install prisma@prev --save-dev
npm install @prisma/client@7 @prisma/adapter-better-sqlite3 better-sqlite3[!NOTE] Prisma 7 requires a driver adapter to connect to your database. Make sure your
package.jsonincludes"type": "module"for ESM support. See the upgrade guide for details.