跳至主要内容

入门

先决条件​

在开始使用 Prisma Optimize 之前，请确保您拥有以下内容

  • 一个.
  • 使用 Prisma Client 版本 5.0.0 或更高版本（建议使用最新版本）的项目。
  • 一个 PostgreSQL、MySQL/MariaDB、CockroachDB 或 MS SQL Server 数据库。
注意

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

1. 启动 Optimize​

  1. 登录您的.
  2. 按照说明 访问并启动 Prisma Optimize。

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

2.1. 更新您的 schema.prisma 文件​

在您的 Prisma 架构的 generator 块中，添加 tracing 预览功能

generator client {
  provider = "prisma-client-js"
  previewFeatures = ["tracing"]
}

然后，生成 Prisma Client

npx prisma generate

2.2. 安装 Optimize Prisma Client 扩展​

安装 Prisma Client 和 Optimize 扩展的最新版本

npm install @prisma/client@latest @prisma/extension-optimize

2.3. 将 Optimize API 密钥添加到您的 .env 文件​

生成 Prisma Optimize API 密钥 并将其添加到您的 .env 文件

OPTIMIZE_API_KEY="YOUR_OPTIMIZE_API_KEY"

2.4. 扩展您的 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 仪表板中，单击 **开始录制** 按钮，然后运行您的应用程序并在录制处于活动状态时执行一些 Prisma 查询。

  2. 在您的应用程序运行并基于执行的 Prisma 查询生成洞察之后，单击 **停止录制** 按钮。

  3. 通过单击 查看单个查询详细信息，并查看 **建议** 选项卡，了解任何建议的改进以增强查询性能。

    信息

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

为了获得动手学习体验，请尝试使用 逐步示例.

需要帮助?​

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