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

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

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

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

フォーマットレベル​

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

  1. Pretty Error（デフォルト）：色、コードのシンタックスハイライト、および問題の考えられる解決策を含む拡張エラーメッセージを含む完全なスタックトレースが含まれます。
  2. Colorless Error：プリティエラーと同じですが、色はありません。
  3. Minimal Error：生のエラーメッセージ。

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

  • 環境変数を介して設定オプションを設定する
  • PrismaClientコンストラクタに設定オプションを提供する

環境変数を介したフォーマット​

  • NO_COLOR：この環境変数が提供されている場合、エラーメッセージから色が削除されます。したがって、Colorless Errorになります。NO_COLOR環境変数は、こちらで説明されている標準です。
  • NODE_ENV=production：環境変数NODE_ENVがproductionに設定されている場合、Minimal Errorのみが出力されます。これにより、本番環境でのログの消化が容易になります。

PrismaClientコンストラクタを介したフォーマット​

または、エラーフォーマットを設定するには、PrismaClienterrorFormatパラメータを使用してください

const prisma = new PrismaClient({
  errorFormat: 'pretty',
})