始める
前提条件
Prisma Optimize を始める前に、以下のものがあることを確認してください。
- A.
- Prisma Client バージョン
5.0.0
以降を使用するプロジェクト(最新バージョンの使用を推奨します)。 - PostgreSQL、MySQL/MariaDB、CockroachDB、または MS SQL Server データベース。
Prisma Optimize はローカル環境での使用を目的としています。詳しくはFAQをご覧ください。
1. Optimize の起動
- ログインしてください.
- 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 スキーマファイルで 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 インスタンスを拡張する
既存の Prisma Client インスタンスを Optimize 拡張機能で拡張します
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 でクエリのインサイト生成を開始するには、以下の手順に従ってください
-
Optimize ダッシュボードで「レコーディングを開始」ボタンをクリックし、レコーディング中にアプリを実行して Prisma クエリを実行します。
-
アプリの実行が完了し、実行された Prisma クエリに基づいてインサイトが生成されたら、「レコーディングを停止」ボタンをクリックします。
-
個々のクエリをクリックして詳細を確認し、「推奨事項」タブでクエリパフォーマンスを向上させるための提案された改善点を確認してください。
情報Prisma AI を使用して推奨事項を理解し、Prisma モデルのコンテキスト内で適用してください。
実践的な学習体験のために、ステップバイステップの例を試してみてください。
ヘルプが必要ですか?
サポートが必要な場合は、私たちのDiscordの#help-and-questions
チャンネルでお問い合わせいただくか、私たちのコミュニティに接続して、他の人が Optimize をどのように使用しているかを確認してください。