跳到主要內容

開始使用

先決條件​

在開始使用 Prisma Optimize 之前，請確保您具備以下條件

  • A.
  • 一個使用 Prisma Client 5.0.0 或更高版本的專案（我們建議使用最新版本）。
  • 一個 PostgreSQL、MySQL/MariaDB、CockroachDB 或 MS SQL Server 資料庫。
注意

Prisma Optimize 旨在用於本地環境。在 常見問題 中了解更多資訊。

1. 啟動 Optimize​

  1. 登入您的.
  2. 依照指示存取並啟動 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 preview 功能。

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())

如果您在應用程式中使用 Prisma Middleware，請確保它們在任何 Prisma Client 擴充功能（如 Optimize）之前新增。例如

const prisma = new PrismaClient().$use(middleware).$extends(withOptimize())

2.5. 使用 Prisma Optimize 產生洞察​

依照這些步驟開始使用 Prisma Optimize 產生查詢洞察

  1. 在 Optimize 儀表板中，點擊 開始錄製 按鈕，然後執行您的應用程式並在錄製活動時執行一些 Prisma 查詢。

  2. 在您的應用程式執行並根據執行的 Prisma 查詢產生洞察後，點擊 停止錄製 按鈕。

  3. 點擊個別查詢以瀏覽其詳細資訊，並查看 建議 標籤以獲取任何關於增強查詢效能的建議改進。

    資訊

    使用 Prisma AI 了解建議並將其應用於您的 Prisma 模型環境中。

為了獲得實作學習體驗，請試試逐步範例。

需要協助嗎？​

如果您需要協助，請在我們的 Discord 上的 #help-and-questions 頻道中聯繫，或與我們的社群聯繫，看看其他人如何使用 Optimize。