入門指南
先決條件
在開始使用 Prisma Optimize 之前,請確保您已具備以下條件:
- A.
- 一個使用 Prisma Client
5.0.0或更高版本的專案(我們建議使用最新版本)。 - 一個 PostgreSQL、MySQL/MariaDB、CockroachDB 或 MS SQL Server 資料庫。
Prisma Optimize 旨在於本地開發環境中使用。詳情請參閱 常見問題 (FAQ)。
1. 啟動 Optimize
- 登入您的.
- 依照說明存取並啟動 Prisma Optimize。
2. 將 Optimize 加入您的應用程式
2.1. 安裝 Optimize Prisma Client 擴充套件
安裝 Prisma Client 和 Optimize 擴充套件
npm install @prisma/client@latest @prisma/extension-optimize
在較舊版本的 Prisma ORM 中啟用追蹤 (Tracing)
對於 4.2.0 到 6.1.0 之間的 Prisma ORM 版本,您需要在 Prisma schema 檔案中啟用 tracing 預覽功能。
generator client {
provider = "prisma-client-js"
previewFeatures = ["tracing"]
}
2.2. 將 Optimize API 金鑰加入您的 .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())
2.5. 使用 Prisma Optimize 產生洞察分析
請依照以下步驟開始使用 Prisma Optimize 產生查詢洞察:
-
在 Optimize 儀表板中,點擊開始錄製 (Start recording) 按鈕,然後執行您的應用程式並在錄製期間執行一些 Prisma 查詢。
-
在您的應用程式執行完畢並根據所執行的 Prisma 查詢產生洞察後,點擊停止錄製 (Stop recording) 按鈕。
-
點擊個別查詢詳情以進行探索,並檢查建議 (Recommendations) 分頁,查看是否有任何能提升查詢效能的建議。
資訊使用 Prisma AI 來理解建議內容,並在您的 Prisma 模型情境中套用它們。
如需實作學習體驗,請嘗試此逐步教學範例。
需要協助嗎?
如果您需要協助,請加入我們 Discord 上的 #help-and-questions 頻道,或與我們的社群交流,看看其他人是如何使用 Optimize 的。