| name | cermont.backend.prisma-v7 |
| description | Expert guidance for Prisma ORM v7 (7.0+). Use when working with Prisma schema files, migrations, Prisma Client queries, database setup. Covers ESM modules, driver adapters, prisma.config.ts, Rust-free client. |
| triggers | ["Prisma","schema.prisma","@prisma/client","database models","ORM","migrations"] |
| role | secondary |
| scope | backend |
Project Fit
| Attribute | Value |
|---|
| Applies to | backend |
| Requires | NestJS, Prisma, pnpm |
| Not for this repo | TypeORM, Sequelize |
| Status | Active (v7 patterns for future upgrade) |
[!NOTE]
Cermont currently uses Prisma v6. This skill documents v7 patterns for future migration.
Guardrails
Safety Checklist:
pnpm --filter @cermont/backend prisma validate
pnpm --filter @cermont/backend prisma generate
pnpm --filter @cermont/backend test
Core v7 Changes
1. ES Modules (ESM) Required
Prisma v7 ships as an ES module. Your project must use ESM:
package.json:
{
"type": "module"
}
tsconfig.json:
{
"compilerOptions": {
"module": "ESNext",
"moduleResolution": "Node",
"target": "ES2023",
"strict": true,
"esModuleInterop": true
}
}
2. Driver Adapters Required
All databases now require driver adapters. The Rust-free client provides better performance and smaller bundle sizes.
Available Adapters:
- PostgreSQL:
@prisma/adapter-pg (with pg driver)
- MySQL/MariaDB:
@prisma/adapter-mariadb (with mariadb driver)
- SQLite:
@prisma/adapter-better-sqlite3 (with better-sqlite3)
- CockroachDB:
@prisma/adapter-pg (with pg driver)
- Neon:
@prisma/adapter-neon (with @neondatabase/serverless)
- PlanetScale:
@prisma/adapter-planetscale (with @planetscale/database)
- D1 (Cloudflare):
@prisma/adapter-d1
- MSSQL:
@prisma/adapter-mssql
3. Generator Configuration
The output field is now required and the new prisma-client provider is standard:
generator client {
provider = "prisma-client"
output = "./generated/prisma"
}
Note: Client is no longer generated in node_modules by default.
4. Prisma Config File (prisma.config.ts)
Database URLs and CLI configuration now live in prisma.config.ts instead of the schema file.
Basic setup:
import 'dotenv/config'
import { defineConfig, env } from 'prisma/config'
export default defineConfig({
schema: 'prisma/schema.prisma',
migrations: {
path: 'prisma/migrations',
},
datasource: {
url: env('DATABASE_URL'),
},
})
Note: For Bun, skip import 'dotenv/config' as it auto-loads .env files.
5. Schema Datasource Block
Remove url, directUrl, and shadowDatabaseUrl from schema.prisma:
v7 schema.prisma:
datasource db {
provider = "postgresql"
// url field removed - now in prisma.config.ts
}
generator client {
provider = "prisma-client"
output = "./generated/prisma"
}
Installation & Setup
New Project
npm install prisma@latest @prisma/client@latest
npm install @prisma/adapter-pg pg
npm install @prisma/adapter-mariadb mariadb
npm install @prisma/adapter-better-sqlite3 better-sqlite3
npm install -D tsx dotenv
npx prisma init
Upgrading from v6
npm install prisma@latest @prisma/client@latest
npm install @prisma/adapter-pg pg
npm install dotenv
npx prisma generate
Client Instantiation
PostgreSQL Example
import { PrismaClient } from './generated/prisma/client'
import { PrismaPg } from '@prisma/adapter-pg'
import 'dotenv/config'
const adapter = new PrismaPg({
connectionString: process.env.DATABASE_URL
})
const prisma = new PrismaClient({ adapter })
export default prisma
MySQL/MariaDB Example
import { PrismaClient } from './generated/prisma/client'
import { PrismaMariaDb } from '@prisma/adapter-mariadb'
import 'dotenv/config'
const adapter = new PrismaMariaDb({
host: 'localhost',
port: 3306,
connectionLimit: 5
})
const prisma = new PrismaClient({ adapter })
export default prisma
SQLite Example
import { PrismaClient } from './generated/prisma/client'
import { PrismaBetterSqlite3 } from '@prisma/adapter-better-sqlite3'
import 'dotenv/config'
const adapter = new PrismaBetterSqlite3({
url: process.env.DATABASE_URL || 'file:./dev.db'
})
const prisma = new PrismaClient({ adapter })
export default prisma
Prisma Accelerate (Caching/Pooling)
If using Prisma Accelerate for caching, do NOT use a driver adapter:
import { PrismaClient } from './generated/prisma/client'
import { withAccelerate } from '@prisma/extension-accelerate'
const prisma = new PrismaClient({
accelerateUrl: process.env.DATABASE_URL
}).$extends(withAccelerate())
export default prisma
Important: Never pass prisma:// or prisma+postgres:// URLs to driver adapters.
Schema Best Practices
Complete Schema Example
// schema.prisma
datasource db {
provider = "postgresql"
}
generator client {
provider = "prisma-client"
output = "./generated/prisma"
}
model User {
id Int @id @default(autoincrement())
email String @unique
name String?
posts Post[]
createdAt DateTime @default(now())
updatedAt DateTime @updatedAt
}
model Post {
id Int @id @default(autoincrement())
title String
content String?
published Boolean @default(false)
author User @relation(fields: [authorId], references: [id])
authorId Int
createdAt DateTime @default(now())
updatedAt DateTime @updatedAt
@@index([authorId])
}
Relations
One-to-Many:
model User {
id Int @id @default(autoincrement())
posts Post[]
}
model Post {
id Int @id @default(autoincrement())
author User @relation(fields: [authorId], references: [id])
authorId Int
@@index([authorId])
}
Many-to-Many:
model Post {
id Int @id @default(autoincrement())
categories Category[]
}
model Category {
id Int @id @default(autoincrement())
posts Post[]
}
One-to-One:
model User {
id Int @id @default(autoincrement())
profile Profile?
}
model Profile {
id Int @id @default(autoincrement())
user User @relation(fields: [userId], references: [id])
userId Int @unique
}
Common Commands
npx prisma generate
npx prisma migrate dev --name init
npx prisma migrate deploy
npx prisma migrate reset
npx prisma studio
npx prisma format
npx prisma validate
npx prisma db pull
npx prisma db push
npx prisma db seed
Prisma Client Queries
Basic CRUD
const user = await prisma.user.create({
data: {
email: 'user@example.com',
name: 'John Doe',
},
})
const user = await prisma.user.findUnique({
where: { id: 1 },
})
const users = await prisma.user.findMany({
where: { email: { contains: '@example.com' } },
orderBy: { createdAt: 'desc' },
take: 10,
})
const user = await prisma.user.update({
where: { id: 1 },
data: { name: 'Jane Doe' },
})
const user = await prisma.user.delete({
where: { id: 1 },
})
Relations
const user = await prisma.user.create({
data: {
email: 'user@example.com',
posts: {
create: [
{ title: 'First Post', content: 'Content...' },
{ title: 'Second Post', content: 'More content...' },
],
},
},
})
const userWithPosts = await prisma.user.findUnique({
where: { id: 1 },
include: {
posts: true,
},
})
const user = await prisma.user.findUnique({
where: { id: 1 },
select: {
id: true,
email: true,
posts: {
select: {
id: true,
title: true,
},
},
},
})
Advanced Queries
const posts = await prisma.post.findMany({
where: {
OR: [
{ title: { contains: 'Prisma' } },
{ content: { contains: 'database' } },
],
published: true,
author: {
email: { endsWith: '@prisma.io' },
},
},
})
const result = await prisma.post.aggregate({
_count: true,
_avg: { authorId: true },
_sum: { authorId: true },
})
const groups = await prisma.post.groupBy({
by: ['authorId'],
_count: true,
having: {
authorId: { gt: 10 },
},
})
const [user, post] = await prisma.$transaction([
prisma.user.create({ data: { email: 'user@example.com' } }),
prisma..({ : { : , : } }),
])
prisma.$transaction( (tx) => {
user = tx..({
: { : },
})
tx..({
: { : , : user. },
})
})
Migration Workflow
Development
npx prisma migrate dev --name add_user_table
npx prisma migrate dev
npx prisma migrate reset
Production
npx prisma migrate deploy
npx prisma migrate status
Prototyping
npx prisma db push
Environment Variables
.env:
DATABASE_URL="postgresql://user:password@localhost:5432/mydb?schema=public"
DATABASE_URL="mysql://user:password@localhost:3306/mydb"
DATABASE_URL="file:./dev.db"
DATABASE_URL="prisma://accelerate.prisma-data.net/?api_key=..."
DIRECT_DATABASE_URL="postgresql://user:password@localhost:5432/mydb"
Connection Pooling
In v7, connection pooling is handled by the driver adapter, not by Prisma's URL parameters.
PostgreSQL with pg driver:
import { Pool } from 'pg'
import { PrismaPg } from '@prisma/adapter-pg'
import { PrismaClient } from './generated/prisma/client'
const pool = new Pool({
connectionString: process.env.DATABASE_URL,
max: 10,
})
const adapter = new PrismaPg(pool)
const prisma = new PrismaClient({ adapter })
Seeding
package.json:
{
"prisma": {
"seed": "tsx prisma/seed.ts"
}
}
prisma/seed.ts:
import { PrismaClient } from '../generated/prisma/client'
import { PrismaPg } from '@prisma/adapter-pg'
import 'dotenv/config'
const adapter = new PrismaPg({
connectionString: process.env.DATABASE_URL
})
const prisma = new PrismaClient({ adapter })
async function main() {
const user = await prisma.user.create({
data: {
email: 'admin@example.com',
name: 'Admin User',
},
})
console.log('Seeded:', user)
}
main()
.catch((e) => {
console.error(e)
process.exit(1)
})
.finally(async () => {
await prisma.$disconnect()
})
Run with: npx prisma db seed
Troubleshooting
Module Resolution Errors
Problem: Cannot find module './generated/prisma/client'
Solution:
- Ensure
"type": "module" in package.json
- Run
npx prisma generate
- Check output path in generator block
- Restart TypeScript server
Connection Errors (P1017)
Problem: Cannot connect to database
Solution:
- Verify DATABASE_URL is correct
- Ensure
import 'dotenv/config' is at the top of files
- Check network connectivity
- Verify database is running
Migration Fails
Problem: Migration cannot be applied
Solution:
- Check schema syntax with
npx prisma validate
- Review migration file in
prisma/migrations/
- Use
npx prisma migrate reset in development
- For production, manually fix and use
npx prisma migrate resolve
Performance Tips
- Use select instead of include when you don't need all fields
- Add indexes for frequently queried fields:
@@index([email])
@@index([authorId, createdAt])
- Use connection pooling with appropriate pool sizes
- Batch operations when possible:
await prisma.user.createMany({
data: [{ email: 'a@b.com' }, { email: 'c@d.com' }]
})
- Use raw queries for complex operations:
await prisma.$queryRaw`SELECT * FROM users WHERE email LIKE ${'%@example.com'}`
Security Best Practices
- Never commit .env files - add to .gitignore
- Use environment variables for sensitive data
- Validate input before passing to Prisma queries
- Use parameterized queries (Prisma does this automatically)
- Limit exposed fields with select/omit in production APIs
- Set appropriate connection limits to prevent exhaustion
- Use read replicas for scaling read operations
Key Differences from v6
| Aspect | v6 | v7 |
|---|
| Module System | CommonJS or ESM | ESM only |
| Client Generator | prisma-client-js | prisma-client |
| Output Location | node_modules default | Custom path required |
| Database Connection | Built-in drivers | Driver adapters required |
| Config Location | schema.prisma | prisma.config.ts |
| Environment Variables | Auto-loaded | Must use dotenv or Bun |
| Rust Dependencies | Yes | No (Rust-free) |
Additional Resources
Common Patterns
Singleton Pattern for Prisma Client
import { PrismaClient } from './generated/prisma/client'
import { PrismaPg } from '@prisma/adapter-pg'
import 'dotenv/config'
const globalForPrisma = globalThis as unknown as {
prisma: PrismaClient | undefined
}
const adapter = new PrismaPg({
connectionString: process.env.DATABASE_URL
})
export const prisma = globalForPrisma.prisma ?? new PrismaClient({ adapter })
if (process.env.NODE_ENV !== 'production') {
globalForPrisma.prisma = prisma
}
Type-safe Enums
enum Role {
USER
ADMIN
MODERATOR
}
model User {
id Int @id @default(autoincrement())
role Role @default(USER)
}
Usage:
import { Role } from './generated/prisma/client'
const admin = await prisma.user.create({
data: {
email: 'admin@example.com',
role: Role.ADMIN,
},
})
When to Use Prisma
Good fit:
- Type-safe database access
- Complex relations and queries
- Auto-generated migrations
- TypeScript projects
- Need for type safety and IntelliSense
Consider alternatives if:
- Need MongoDB (wait for v7 support)
- Existing complex SQL procedures
- Extreme performance requirements
- Very simple CRUD without relations
Notes
- Always run
npx prisma generate after schema changes
- Use
npx prisma studio to visualize your database
- Keep migrations in version control
- Test migrations on staging before production
- Use
npx prisma format to keep schema clean
- The Rust-free client in v7 is faster and has a smaller bundle size
- Driver adapters enable serverless/edge deployment