跳至主要内容

设置

先决条件​

在开始使用 Prisma Optimize for Prisma Postgres 之前，请确保您已具备以下条件

注意

Prisma Optimize 旨在用于本地环境。请在 常见问题 中了解更多信息。

1. 启动 Optimize​

  1. 登录您的.
  2. 点击左侧导航栏上的 Optimize 选项卡。
  3. 点击 Generate API key 按钮。
  4. 复制显示的 API 密钥并将其粘贴到安全的地方，例如密码管理器。
  5. 点击复制图标，继续通过每个设置屏幕，直到看到 Finish & optimize 按钮。点击该按钮完成设置。
  6. 完成后，Optimize 将自动在后台开始新的录制会话。

2. 将 Optimize 添加到您的应用程序​

2.1. 安装所需的 Prisma Client 扩展​

在终端中运行以下命令安装必要的依赖项

npm install @prisma/extension-optimize
在旧版本 Prisma ORM 中启用追踪

对于 Prisma ORM 版本 4.2.0 到 6.1.0，您需要在 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 开始生成查询洞察

  1. 运行您的应用程序，并在录制活动时执行一些 Prisma 查询。

  2. 在您的应用程序运行并根据执行的 Prisma 查询生成洞察后，点击红色的 Recording 按钮。

  3. 通过点击来探索单个查询详情，并查看 Recommendations 选项卡以获取任何建议的改进，从而提升查询性能。

    信息

    使用 Prisma AI 来理解建议并在您的 Prisma 模型上下文中应用它们。

需要帮助？​

如果您需要帮助，请在我们的 Discord 的 #help-and-questions 频道中联系我们，或者与我们的社区联系，看看其他人是如何使用 Optimize 的。