comp_errとは？MySQLエラーメッセージファイルのコンパイル方法を解説

comp_errは、MySQLに同梱されているユーティリティプログラムの一つで、errmsg.sysファイルを生成する役割を担います。このerrmsg.sysは、mysqldサーバーが各種エラーコードに対してどのエラーメッセージを表示すべきかを判定する際に参照されるファイルです。

エラー情報のソースとなるファイル

現在のMySQLでは、エラー情報はshareディレクトリ内にある以下の2つのテキストファイルから取得されます。

• messages_to_error_log.txt（エラーログ向けメッセージ）
• messages_to_clients.txt（クライアント向けメッセージ）

なお、MySQL 8.0.19より前のバージョンでは、sql/shareディレクトリ内のerrmsg-utf8.txtファイルがエラー情報のソースとして使用されていました。バージョンアップに伴い入力ファイルが変更された点には注意が必要です。

さらに、comp_errはerrmsg.sysのほかに、以下の3つのヘッダーファイルも生成します。

• mysqld_error.h
• mysqld_ername.h
• mysqld_errmsg.h

comp_errの実行方法

comp_errは、次のようにコマンドラインから起動できます。

shell> comp_err [options]

オプションを指定しなくてもデフォルト値で動作しますが、用途に応じて細かく設定を変更することが可能です。

主なオプション一覧

--charset=dir_name, -C dir_name

文字セットディレクトリを指定します。デフォルト値は「../sql/share/charsets」です。

--debug=debug_options, -# debug_options

デバッグログを出力します。典型的なdebug_options文字列は「d:t:O,file_name」の形式で、デフォルト値は「d:t:O,/tmp/comp_err.trace」です。

--debug-info, -T

プログラム終了時にデバッグ情報を表示します。

--errmsg-file=file_name, -H file_name

エラーメッセージファイルの名前を指定します。デフォルト値は「mysqld_errmsg.h」です。このオプションはMySQL 8.0.18で追加されました。

--header-file=file_name, -H file_name

エラーヘッダーファイルの名前を指定します。デフォルト値は「mysqld_error.h」です。

--in-file-errlog=file_name, -e file_name

エラーログに出力されるメッセージを定義した入力ファイルの名前を指定します。デフォルト値は「../share/messages_to_error_log.txt」です。

--name-file=file_name, -N file_name

エラー名ファイルの名前を指定します。デフォルト値は「mysqld_ername.h」です。

--out-dir=dir_name, -D dir_name

出力先となるベースディレクトリの名前を指定します。デフォルト値は「../sql/share/」です。

--out-file=file_name, -O file_name

出力ファイルの名前を指定します。デフォルト値は「errmsg.sys」です。

--version, -V

バージョン情報を表示して終了します。

まとめ

comp_errはMySQLのビルドプロセスにおいて重要な役割を果たすツールであり、エラーコードとメッセージの対応関係を定義するerrmsg.sysや関連ヘッダーファイルを自動生成します。通常、開発者が直接操作することは少ないものの、MySQLのソースからビルドを行う場合や、カスタムエラーメッセージを扱う際にはその仕組みを理解しておくと有用です。