SHOW PROCEDURE CODEの代替方法: より安全で効率的なデバッグ

MariaDB SHOW PROCEDURE CODE の詳細解説

SHOW PROCEDURE CODE は、MariaDB 独自の拡張機能であり、デバッ グ用に構築されたサーバーでのみ使用できます。このステートメントは、指定されたストアドプロシージャの内部実装形式を表示します。

構文

SHOW PROCEDURE CODE proc_name;

パラメータ

• proc_name: 表示したいストアドプロシージャの名前

結果

このステートメントは、以下の列を含む結果セットを返します。

• Pos: 命令の порядковый 番号 (0 から開始)
• Line: ソースコード内の行番号
• OpCode: 命令コード
• Info: 命令に関する情報

例

SHOW PROCEDURE CODE get_customer;

この例では、get_customer という名前のストアドプロシージャの内部実装形式が表示されます。

出力例

Pos | Line | OpCode | Info
------- | -------- | -------- | --------
0 | 1 | BEGIN |
1 | 2 | SET @name = 'John Doe'; |
2 | 3 | SELECT * FROM customers WHERE name = @name; |
3 | 4 | END; |

注意事項

• このステートメントは、デバッグ目的でのみ使用してください。
• このステートメントは、パフォーマンスに影響を与える可能性があります。
• このステートメントは、MariaDB 以外のデータベースサーバーでは使用できません。

補足

• SHOW PROCEDURE CODE と同様の機能を持つステートメントとして、SHOW CREATE PROCEDURE があります。SHOW CREATE PROCEDURE は、ストアドプロシージャのソースコードを表示します。
• SHOW PROCEDURE CODE は、MariaDB 10.0 から導入されました。

• 上記の説明で理解できない点があれば、遠慮なく質問してください。
• MariaDB に関する情報は、MariaDB 公式ドキュメントを参照してください。

MariaDB SHOW PROCEDURE CODE サンプルコード

DELIMITER //

CREATE PROCEDURE get_customer(IN customer_id INT)
BEGIN
  SELECT * FROM customers WHERE customer_id = customer_id;
END //

DELIMITER ;

SHOW PROCEDURE CODE 出力

Pos | Line | OpCode | Info
------- | -------- | -------- | --------
0 | 1 | BEGIN |
1 | 2 | SET @customer_id = customer_id; |
2 | 3 | SELECT * FROM customers WHERE customer_id = @customer_id; |
3 | 4 | END; |

条件分岐を含むストアドプロシージャ

DELIMITER //

CREATE PROCEDURE get_customer_by_country(IN country_code VARCHAR(2))
BEGIN
  IF country_code = 'JP' THEN
    SELECT * FROM customers WHERE country = 'Japan';
  ELSE
    SELECT * FROM customers WHERE country = country_code;
  END IF;
END //

DELIMITER ;

SHOW PROCEDURE CODE 出力

Pos | Line | OpCode | Info
------- | -------- | -------- | --------
0 | 1 | BEGIN |
1 | 2 | IF country_code = 'JP' THEN |
2 | 3 |   SELECT * FROM customers WHERE country = 'Japan'; |
3 | 4 | ELSE |
4 | 5 |   SELECT * FROM customers WHERE country = country_code; |
5 | 6 | END IF; |
6 | 7 | END; |

ループ処理を含むストアドプロシージャ

DELIMITER //

CREATE PROCEDURE get_all_customers()
BEGIN
  DECLARE customer_id INT;
  DECLARE done INT DEFAULT FALSE;

  SET customer_id = 1;

  WHILE NOT done DO
    SELECT * FROM customers WHERE customer_id = customer_id;
    SET customer_id = customer_id + 1;

    IF customer_id > 100 THEN
      SET done = TRUE;
    END IF;
  END WHILE;
END //

DELIMITER ;

SHOW PROCEDURE CODE 出力

Pos | Line | OpCode | Info
------- | -------- | -------- | --------
0 | 1 | BEGIN |
1 | 2 | DECLARE customer_id INT; |
2 | 3 | DECLARE done INT DEFAULT FALSE; |
3 | 4 | SET customer_id = 1; |
4 | 5 | WHILE NOT done DO |
5 | 6 |   SELECT * FROM customers WHERE customer_id = customer_id; |
6 | 7 |   SET customer_id = customer_id + 1; |
7 | 8 |   IF customer_id > 100 THEN |
8 | 9 |     SET done = TRUE; |
9 | 10 |   END IF; |
10 | 11 | END WHILE; |
11 | 12 | END; |

カーソルを使用するストアドプロシージャ

DELIMITER //

CREATE PROCEDURE get_customers_by_order(IN order_id INT)
BEGIN
  DECLARE cursor_name CURSOR FOR SELECT * FROM customers WHERE order_id = order_id;

  OPEN cursor_name;

  FETCH NEXT FROM cursor_name INTO @customer_id, @customer_name;

  WHILE ROW_COUNT() > 0 DO
    SELECT * FROM orders WHERE customer_id = @customer_id;
    FETCH NEXT FROM cursor_name INTO @customer_id, @customer_name;
  END WHILE;

  CLOSE cursor_name;
END //

DELIMITER ;

SHOW PROCEDURE CODE 出力

Pos | Line | OpCode | Info
------- | -------- | -------- | --------
0 | 1 | BEGIN |
1 | 2 | DECLARE cursor_name CURSOR FOR SELECT * FROM customers WHERE order_id = order_id; |
2 | 3 | OPEN cursor_name; |
3 | 4 | FETCH NEXT FROM cursor_name INTO @customer_id, @customer_name; |
4 | 5 | WHILE ROW_COUNT() > 0 DO |
5 | 6 |   SELECT * FROM orders WHERE customer_id = @customer_id; |
6 | 7 |   FETCH NEXT FROM cursor_name INTO @customer_id, @customer_name; |
7 | 8 | END WHILE; |
8 | 9 |

SHOW PROCEDURE CODE の代替方法

SHOW CREATE PROCEDURE は、指定されたストアドプロシージャのソースコードを表示します。デバッグだけでなく、ストアドプロシージャの構造や動作を理解するのにも役立ちます。

例

SHOW CREATE PROCEDURE get_customer;

出力例

CREATE PROCEDURE get_customer(IN customer_id INT)
BEGIN
  SELECT * FROM customers WHERE customer_id = customer_id;
END

EXPLAIN PLAN は、ストアドプロシージャの実行計画を表示します。ストアドプロシージャのパフォーマンスを分析する際に役立ちます。

例

EXPLAIN PLAN FOR get_customer(1);

出力例

id | select_type | table | type | possible_keys | key | key_len | ref | rows | filtered | Extra
------- | -------- | -------- | -------- | -------- | -------- | -------- | -------- | -------- | -------- | --------
1 | SIMPLE | customers | ALL | NULL | NULL | NULL | NULL | 100 | 100 | Using where

デバッガーの使用

MariaDB には、dbx コマンドなど、デバッガーが用意されています。デバッガーを使用すると、ストアドプロシージャの実行をステップ実行したり、変数の値を確認したりできます。

ソースコードの確認

ストアドプロシージャのソースコードを確認することで、内部実装形式を理解することができます。ソースコードは、MariaDB サーバーの mysql データベースの proc テーブルに保存されています。

例

SELECT body FROM mysql.proc WHERE name = 'get_customer';

出力例

DELIMITER //

CREATE PROCEDURE get_customer(IN customer_id INT)
BEGIN
  SELECT * FROM customers WHERE customer_id = customer_id;
END //

DELIMITER ;

注意事項

• 上記の方法は、すべて MariaDB 10.0 以降で利用可能です。
• SHOW PROCEDURE CODE の代替方法を選択する際は、目的に応じて適切な方法を選択する必要があります。