跳至主要内容

入门

先决条件​

在开始使用 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 中启用追踪

对于 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 { 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 中间件，请确保在任何 Prisma Client 扩展（如 Optimize）之前添加它们。例如

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

2.5. 使用 Prisma Optimize 生成洞察​

按照这些步骤开始使用 Prisma Optimize 生成查询洞察

  1. 在 Optimize 面板中，点击 Start recording 按钮，然后运行您的应用程序并在录制激活时执行一些 Prisma 查询。

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

  3. 点击查询探索 单个查询详情，并查看 Recommendations 选项卡，了解任何建议的改进，以增强查询性能。

    信息

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

要获得实践学习体验，请尝试 分步示例。

需要帮助？​

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