跳到主要内容

设置

先决条件​

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

注意

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

1. 启动 Optimize​

  1. 登录您的.
  2. 点击左侧导航栏中的 Optimize 选项卡。
  3. 点击 生成 API 密钥 按钮。
  4. 复制显示的 API 密钥并粘贴到安全的地方，例如密码管理器。
  5. 点击复制图标，继续完成每个设置屏幕，直到您看到 完成并优化 按钮。点击它以完成设置。
  6. 完成后，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 生成查询洞察：

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

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

  3. 点击查询以探索单个查询详细信息，并查看 建议 选项卡以获取任何改进查询性能的建议。

    信息

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

需要帮助？​

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

© . All rights reserved.