こんにちは！データベースの裏側でうごめく複雑なストアドプロシージャやトリガーの挙動に頭を悩ませていませんか？
「どこで値が狂ったのか分からない」「`RAISE NOTICE`を何行も仕込んでは消す泥臭いデバッグから抜け出したい……」
そんな苦悩を抱えているあなたへ。実は、PostgreSQLの公式管理ツールであるpgAdmin 4には、プログラミング言語のIDE並みにリッチな「Debugger」プラグインが標準で備わっています。
これをマスターすれば、ブレークポイントの設置、ステップ実行、リアルタイムな変数の監視（ウォッチ）が自由自在になり、毎日のDB開発・保守作業が劇的に楽になりますよ。今日は、その魔法のようなデバッグ環境の整え方から実践的な使い方まで、親身になってステップバイステップで解説していきますね。
—
1. デバッグの前に：なぜpgAdminの「Debugger」が必要なのか？
PostgreSQLのサーバサイド言語（PL/pgSQLなど）は、通常のアプリケーションコード（PythonやNode.jsなど）と違って、そのままではIDEからステップイン実行できません。
そのため、多くのエンジニアがやりがちなのが以下のアンチパターンです：
- コードのあちこちに `RAISE NOTICE ‘value: %’, var;` を埋め込む。
- その都度関数を実行し、ログウィンドウと睨めっこする。
- 修正しては再度 `CREATE OR REPLACE FUNCTION` を実行する。
これでは時間がいくらあっても足りません。pgAdmin 4のDebuggerプラグインを使えば、「今、どの行で、どの変数がどんな状態になっているか」が視覚的に手に取るようにわかるようになります。
—
2. 基礎セットアップ：デバッガーを有効化する
実は、pgAdminのデバッガーを使うには、データベースサーバ側（PostgreSQL）とクライアント側（pgAdmin）の両方での有効化が必要です。ここをクリアするのが最初にして最大の関門なので、丁寧にいきましょう。
Step 1: サーバ側で拡張機能（Extension）を有効にする
PostgreSQLのバックエンド側でデバッグ用のプロシージャをフックするため、`pldbgapi` という拡張機能をインストールします。
対象のデータベースに対して、以下のSQLを実行してください。
— デバッグ用APIを提供する拡張機能を有効化
CREATE EXTENSION IF NOT EXISTS pldbgapi;
※もしここでエラーが出る場合、PostgreSQLのcontribパッケージ（追加モジュール）がサーバにインストールされていない可能性があります（クラウド環境やManaged DBの場合は、マネジメントコンソールから拡張機能を有効にする必要があります）。
Step 2: pgAdmin 4の設定確認
pgAdmin 4のデスクトップ版またはWeb版を使用している場合、Debuggerプラグインはデフォルトで組み込まれています。特別な追加インストールは不要ですが、正しく接続できていることを確認しておきましょう。
—
3. 「Hello World」的動作確認：デバッグ対象の関数を作る
百聞は一見にしかず。実際にデバッグするための「ちょっとしたバグを含んだPL/pgSQL関数」をサクッと作ってみましょう。
以下のコードをpgAdminのSQLツールで実行し、テスト用の関数を作成してください。引数として渡した数値に応じて、ループ処理と条件分岐を行う関数です。
— ==========================================
— テスト用関数の作成
— ==========================================
CREATE OR REPLACE FUNCTION public.func_debug_sample(p_max_count integer)
RETURNS integer
LANGUAGE plpgsql
AS $$
DECLARE
v_sum integer := 0;
v_i integer;
BEGIN
— 1から p_max_count までループを回す
FOR v_i IN 1..p_max_count LOOP
— 偶数のときだけ加算する（奇数はスキップ）
IF v_i % 2 = 0 THEN
v_sum := v_sum + v_i;
END IF;
END LOOP;
— 意図的に少し複雑な計算結果を返す
RETURN v_sum 2;
END;
$$;
COMMENT ON FUNCTION public.func_debug_sample(integer) IS ‘デバッグ実習用のサンプル関数’;
—
4. いざ実践！ステップ実行と変数のウォッチ
さあ、いよいよ本番です。pgAdminのGUIを使って、先ほど作った関数をデバッグしてみましょう。
① デバッガーの起動
1. pgAdminのオブジェクトツリーから、対象のデータベース ＞ スキーマ ＞ public ＞ 関数 (Functions) を展開します。
2. 先ほど作成した `func_debug_sample(integer)` を右クリックします。
3. メニューから [Debugging] ＞ [Debug…] を選択します。
(※「Debugging」が表示されない場合は、Step 1の `CREATE EXTENSION` が正しく実行されているか確認してください)
② 引数の入力ダイアログ
デバッグ実行用のウィンドウがポップアップし、「この関数に渡す引数の値（Parameters）」を聞かれます。
- `p_max_count`: `5` と入力します。
- 画面下の [Debugger] ボタン（または「Debug」）をクリックします。
③ デバッグ画面（コンソール）の解説
専用のデバッグ画面が別タブ（またはウィンドウ）で立ち上がります。ここがあなたのコックピットです！画面は大きく3つに分かれています。
1. ソースコードビュー（上部）:
関数のコードが表示され、現在実行中の行が黄色くハイライトされます。
2. コントロールツールバー（最上部）:
- Play (続行): 次のブレークポイントまで一気に実行します。
- Step Into (ステップイン): 1行ずつ実行します（関数呼び出しがあれば中に入ります）。
- Step Over (ステップオーバー): 関数の中に入らず、現在の行を1ステップとして実行します。
- Toggle Breakpoint (ブレークポイントの切替): 任意の行で一時停止させます。
3. データ・変数の監視エリア（下部タブ）:
- Local variables (ローカル変数): `v_sum` や `v_i` などの現在の値がリアルタイムで更新されます。
- Stack (コールスタック): どの関数から呼び出されたかの履歴が表示されます。
④ 実際にステップ実行してみよう
1. ソースコードの `FOR v_i IN 1..p_max_count LOOP` の行（あるいはその中の `IF` 行）の行番号をクリックして、赤い丸（ブレークポイント）を置きます。
2. ツールバーの [Play] ボタンを押すと、その行で処理がピタッと止まります。
3. 下部の [Local variables] を見てください。`p_max_count` に `5` が入り、`v_sum` が `0` で初期化されているのが一目でわかります。
4. [Step Into] ボタンを何回かポチポチ押してみましょう。ループが回るたびに `v_i` や `v_sum` の数値が書き換わっていく様子が生々しく確認できます。
これ、すごく感動的じゃないですか？「あ、ここで意図しない値になってる！」という瞬間をダイレクトに捕らえられるため、複雑なロジックも怖くなくなります。
—
5. 知っておくと得する、現場のプロの知恵（TIPS）
最後に、実務でpgAdminのデバッガーを使うときに知っておくべき「知見」をいくつかシェアしておきます。
- トリガー（Trigger）のデバッグ方法
「トリガー関数」単体は、直接デバッグメニューから実行できません（引数や `NEW`/`OLD` レコードが存在しないため）。トリガーをデバッグしたいときは、「そのトリガーが発火するような元となるSQL（INSERTやUPDATE）」を通常のQuery Toolで実行し、その直前にトリガー関数側にブレークポイントを仕込んでおくことで、トリガーの内部に入り込むことができます。
- 権限に注意する
デバッグを行うデータベースロール（ユーザー）は、スーパーユーザーであるか、あるいは対象の関数に対する十分な実行権限とデバッグ権限を持っている必要があります。本番環境で安易にスーパーユーザー権限以外でハマったときは、権限周りを確認してみてください。
—
まとめ
今回は、pgAdmin 4の「Debugger」プラグインを使って、PL/pgSQLのコードをステップ実行・デバッグする方法を解説しました。
- サーバ側で `CREATE EXTENSION pldbgapi;` を忘れずに。
- 関数を右クリックして `[Debugging]` ＞ `[Debug…]` から起動。
- ブレークポイントとローカル変数ビューを駆使して、泥臭い `RAISE NOTICE` とおさらばする。
データベースのプログラミングは、ブラックボックスになりがちだからこそ、こうした可視化ツールを使いこなせるかどうかがエンジニアとしての生産性を大きく左右します。
ぜひ今日の開発から取り入れて、ストレスフリーなDBライフを手に入れてくださいね！