Djangoのクエリ数をターミナルで確認してデバッグする方法

この記事では、Djangoのライブラリを活用して、データベースのクエリ実行回数をターミナル上に簡潔なレポートとして表示し、デバッグに役立てる方法を紹介します。このツールは、モデルオブジェクトへのアクセス（読み取り・書き込みのどちらでも）が発生するたびに、表形式のレポートを出力します。さらに、リクエストとレスポンスに関する情報も自動的に集計してくれる便利な機能です。

実装例

まずは、アプリの登録やURL設定など、プロジェクトの基本的なセットアップを済ませておきましょう。

次に、django-querycountモジュールをインストールします。

pip install django-querycount

続いて、settings.pyに以下のコードを追加してください。

MIDDLEWARE += [
    'querycount.middleware.QueryCountMiddleware',
]

この設定により、ライブラリの機能が有効化され、プロジェクトの実行時にクエリカウントを利用できるようになります。開発中のパフォーマンスチューニングにおいて非常に有用な仕組みです。

最後に、デバッグ用の出力先（チャンネル）を設定すれば準備完了です。

設定後は、クエリが実行されるたびにターミナル上へ表形式のレポートが表示されます。ただし、この機能はDEBUG=Trueの環境でのみ動作する点に注意してください。あくまでデバッグツールであるため、モデルへの何らかのアクセスがあった場合にのみレポートが出力されます。

また、もう一つ覚えておきたいポイントとして、特定のモデルに対してアクセス（ヒット）が発生した際には、そのモデルに関連する情報だけがレポートとして出力されるという仕様があります。

出力結果