跳到主要内容

开始使用

先决条件​

在使用 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. 安装 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 预览功能。

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

2.2. 将 Optimize API Key 添加到你的 .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。

© . All rights reserved.