メインコンテンツへスキップ

エラーフォーマットの設定

デフォルトでは、Prisma ClientはANSIエスケープ文字を使用して、エラーのスタックをきれいに表示し、問題を解決するための推奨事項を提供します。これはPrisma Clientをターミナルから使用する場合には非常に便利ですが、GraphQL APIのようなコンテキストでは、追加のフォーマットなしで最小限のエラーのみが必要となることがあります。

このページでは、Prisma Clientでエラーのフォーマットを構成する方法について説明します。

フォーマットレベル​

エラーフォーマットレベルは3つあります。

  1. Pretty Error（デフォルト）：色、コードの構文ハイライト、問題に対する解決策を含む拡張されたエラーメッセージを含むフルスタックトレース。
  2. Colorless Error：Pretty Errorと同じですが、色がありません。
  3. Minimal Error：未加工のエラーメッセージ。

これらの異なるエラーフォーマットレベルを設定するには、2つのオプションがあります。

  • 環境変数による設定オプション
  • PrismaClientコンストラクタへの設定オプションの提供

環境変数によるフォーマット​

  • NO_COLOR：この環境変数が指定されている場合、エラーメッセージから色が除去されます。これにより、色なしのエラーとなります。NO_COLOR環境変数は、こちらで説明されている標準です。
  • NODE_ENV=production：環境変数NODE_ENVがproductionに設定されている場合、最小限のエラーのみが出力されます。これにより、本番環境でのログの解析が容易になります。

PrismaClientコンストラクタによるフォーマット​

または、PrismaClientのerrorFormatパラメータを使用してエラーフォーマットを設定します。

const prisma = new PrismaClient({
  errorFormat: 'pretty',
})
© . All rights reserved.