セットアップ
前提条件
Prisma PostgresでPrisma Optimizeを使用開始する前に、以下があることを確認してください
- A.
- Prisma Client バージョン
5.0.0
以降を使用するプロジェクト(最新バージョンの使用を推奨します)。 - Prisma Postgresデータベース。
Prisma Optimizeはローカル環境での使用を意図しています。FAQで詳細を確認してください。
1. Optimizeを起動する
- あなたの.
- 左側のナビゲーションにあるOptimizeタブをクリックしてください。
- Generate API keyボタンをクリックしてください。
- 表示されたAPIキーをコピーし、パスワードマネージャーなど安全な場所に貼り付けてください。
- Finish & optimizeボタンが表示されるまで、コピーアイコンをクリックして各セットアップ画面を進めてください。そのボタンをクリックしてセットアップを完了します。
- 完了すると、Optimizeは自動的にバックグラウンドで新しいレコーディングセッションを開始します。
2. Optimizeをアプリケーションに追加する
2.1. 必要なPrisma Client拡張機能をインストールする
必要な依存関係をインストールするために、ターミナルで以下のコマンドを実行してください
npm install @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 { 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ミドルウェアを使用している場合、Prisma Client拡張機能(Optimizeなど)よりも前にこれらが追加されていることを確認してください。例:
const prisma = new PrismaClient().$use(middleware).$extends(withOptimize()).$extends(withAccelerate())
2.5. Prisma Optimizeを使用してインサイトを生成する
Prisma Optimizeでクエリインサイトの生成を開始するには、以下の手順に従ってください
-
レコーディングがアクティブな間に、アプリケーションを実行し、いくつかのPrismaクエリを実行してください。
-
アプリケーションが実行され、実行されたPrismaクエリに基づいてインサイトが生成されたら、赤いRecordingボタンをクリックしてください。
-
個々のクエリをクリックして詳細を探索し、クエリパフォーマンスを向上させるための推奨事項についてRecommendationsタブを確認してください。
情報Prisma AIを使用して、推奨事項を理解し、Prismaモデルのコンテキスト内で適用してください。
ヘルプが必要ですか?
サポートが必要な場合は、Discordの#help-and-questions
チャンネルでお問い合わせいただくか、コミュニティに接続して、他のユーザーがOptimizeをどのように使用しているかを確認してください。