設定
先決條件
在開始使用 Prisma Postgres 的 Prisma Optimize 之前,請確保您具備以下條件:
- A.
- 使用 Prisma Client
5.0.0或更高版本(我們推薦使用最新版本)的專案。 - 一個 Prisma Postgres 資料庫。
注意
Prisma Optimize 旨在用於本地環境。在常見問題中瞭解更多資訊。
1. 啟動 Optimize
- 登入您的.
- 點選左側導航欄中的 Optimize 選項卡。
- 點選 生成 API 金鑰 按鈕。
- 複製顯示的 API 金鑰並貼上到安全的地方,例如密碼管理器。
- 點選複製圖示,繼續完成每個設定螢幕,直到您看到 完成並最佳化 按鈕。點選它以完成設定。
- 完成後,Optimize 將在後臺自動開始新的錄製會話。
2. 將 Optimize 新增到您的應用程式
2.1. 安裝所需的 Prisma Client 擴充套件
在您的終端中執行以下命令以安裝必要的依賴項
npm install @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 金鑰新增到您的 .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 { withAccelerate } from "@prisma/extension-optimize";
import { withOptimize } from "@prisma/extension-optimize";
const prisma = new PrismaClient().$extends(
withOptimize({ apiKey: process.env.OPTIMIZE_API_KEY }),
).$extends(withAccelerate());
將 Optimize 擴充套件與其他擴充套件或中介軟體一起使用
由於擴充套件是按順序應用的,請確保您以正確的順序應用它們。擴充套件不能共享行為,並且最後應用的擴充套件具有優先權。
const prisma = new PrismaClient().$extends(withOptimize()).$extends(withAccelerate())
如果您的應用程式中使用了 Prisma Middleware,請確保它們在任何 Prisma Client 擴充套件(如 Optimize)之前新增。例如
const prisma = new PrismaClient().$use(middleware).$extends(withOptimize()).$extends(withAccelerate())
2.5. 使用 Prisma Optimize 生成洞察
按照以下步驟開始使用 Prisma Optimize 生成查詢洞察:
-
執行您的應用程式並在錄製啟用時執行一些 Prisma 查詢。
-
在您的應用程式執行並根據已執行的 Prisma 查詢生成洞察後,點選紅色的 錄製 按鈕。
-
點選查詢以探索單個查詢詳細資訊,並檢視 建議 選項卡以獲取任何改進查詢效能的建議。
資訊使用 Prisma AI 來理解建議並在您的 Prisma 模型上下文中應用它們。
需要幫助?
如果您需要幫助,請在我們的 Discord 上的 #help-and-questions 頻道中聯絡我們,或者與我們的社群聯絡,瞭解其他人如何使用 Optimize。