開始使用
先決條件
在使用 Prisma Optimize 之前,請確保你已具備以下條件
- 一個.
- 一個使用 Prisma Client 5.0.0 或更高版本(推薦使用最新版本)的專案。
- 一個 PostgreSQL、MySQL/MariaDB、CockroachDB 或 MS SQL Server 資料庫。
Prisma Optimize 適用於本地環境。欲瞭解更多資訊,請參閱常見問題解答。
1. 啟動 Optimize
- 登入到你的.
- 按照說明操作以訪問和啟動 Prisma Optimize。
2. 將 Optimize 新增到你的應用程式
2.1. 安裝 Optimize Prisma Client 擴充套件
安裝 Prisma Client 和 Optimize 擴充套件
npm install @prisma/client@latest @prisma/extension-optimize
在舊版本 Prisma ORM 中啟用跟蹤
對於 4.2.0 到 6.1.0 之間的 Prisma ORM 版本,你需要在 Prisma schema 檔案中啟用 tracing 預覽功能。
generator client {
provider = "prisma-client-js"
previewFeatures = ["tracing"]
}
2.2. 將 Optimize API Key 新增到你的 .env 檔案
生成一個 Prisma Optimize API 金鑰並將其新增到你的 .env 檔案
OPTIMIZE_API_KEY="YOUR_OPTIMIZE_API_KEY"
2.3. 擴充套件你的 Prisma Client 例項
使用 Optimize 擴充套件來擴充套件你現有的 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 }),
);
將 Optimize 擴充套件與其他擴充套件或中介軟體一起使用
由於擴充套件是按順序應用的,請確保你以正確的順序應用它們。擴充套件不能共享行為,並且最後應用的擴充套件具有優先權。
如果你在應用程式中使用 Prisma Accelerate,請確保在 Optimize 擴充套件之後應用它。例如
const prisma = new PrismaClient().$extends(withOptimize()).$extends(withAccelerate())
如果你在應用程式中使用 Prisma Middleware,請確保在任何 Prisma Client 擴充套件(如 Optimize)之前新增它們。例如
const prisma = new PrismaClient().$use(middleware).$extends(withOptimize())
2.5. 使用 Prisma Optimize 生成洞察
按照以下步驟開始使用 Prisma Optimize 生成查詢洞察
-
在 Optimize 控制面板中,點選開始錄製按鈕,然後在錄製活躍時執行你的應用程式並執行一些 Prisma 查詢。
-
在你的應用程式執行並根據執行的 Prisma 查詢生成洞察後,點選停止錄製按鈕。
-
點選單個查詢詳情進行探索,並檢視建議選項卡以獲取任何提高查詢效能的建議改進。
資訊使用 Prisma AI 理解建議並在你的 Prisma 模型上下文中應用它們。
為了獲得實踐學習體驗,請嘗試分步示例。
需要幫助?
如果你需要幫助,請在我們的 Discord 上的 #help-and-questions 頻道中聯絡我們,或與我們的社群聯絡,瞭解其他人如何使用 Optimize。