Getting started

Prerequisites

Before you begin with Prisma Optimize, ensure you have:

• A Prisma Data Platform account
• A project using Prisma Client
• A PostgreSQL, MySQL/MariaDB, CockroachDB, or MS SQL Server database

1. Launch Optimize

1. Log in to your Prisma Data Platform account
2. Click the Optimize tab in the left navigation
3. Click Generate API key
4. Copy the API key and save it securely
5. Click through the setup screens until you see Finish & optimize

2. Add Optimize to your application

Install the extension

npm install @prisma/extension-optimize

Add API key to .env

OPTIMIZE_API_KEY="YOUR_OPTIMIZE_API_KEY"

Extend Prisma Client

import { PrismaClient } from "@prisma/client";
import { withOptimize } from "@prisma/extension-optimize";

const prisma = new PrismaClient().$extends(
  withOptimize({ apiKey: process.env.OPTIMIZE_API_KEY })
);

Using with other extensions:

Extensions are applied sequentially. If using Prisma Accelerate, apply it after Optimize:

const prisma = new PrismaClient()
  .$extends(withOptimize())
  .$extends(withAccelerate());

3. Generate insights

1. In the Optimize dashboard, click Start recording
2. Run your app and execute Prisma queries
3. Click Stop recording when done
4. Explore query details and check the Recommendations tab

Next steps

• Recommendations - Learn about performance recommendations
• Recordings - Understand recording sessions
• Examples - Try a hands-on example

Need help?

Reach out in the #help-and-questions channel on Discord, or connect with our community.