他のバージョンの文書 15 | 14 | 13 | 12 | 11 | 10 | 9.6 | 9.5 | 9.4 | 9.3 | 9.2 | 9.1 | 9.0 | 8.4 | 8.3 | 8.2 | 8.1 | 8.0 | 7.4 | 7.3 | 7.2

56.2. サーバ内部からのエラーの報告

サーバコード内から生成されるエラー、警告、ログメッセージは、ereportもしくはこれに似た古いelogを使用して作成してください。 この関数の使用はいくつか説明が必要なほど複雑です。

すべてのメッセージには、深刻度レベル(DEBUGからPANICまでの範囲)と主メッセージテキストという、2つの必須要素があります。 さらに、省略可能な要素があります。 その中で最もよく使用されるのは、SQL仕様のSQLSTATE規則に従うエラー識別コードです。 ereport自身はシェルマクロで、主に、メッセージ生成をCソースコード内のひとつの関数呼び出しのように行わせる、構文の便宜上存在します。 ereportで直接受け付けられる唯一のパラメータは深刻度レベルです。 主メッセージテキストと任意の省略可能なメッセージ要素は、ereport呼び出し内でerrmsgなどの補助関数を呼び出すことで生成されます。

典型的なereportの呼び出しは以下のようなものです。

ereport(ERROR,
        errcode(ERRCODE_DIVISION_BY_ZERO),
        errmsg("division by zero"));

これはエラー深刻度レベルERROR(普通のエラー)を指定します。 errcode呼び出しは、src/include/utils/errcodes.hで定義されたマクロを使用してSQLSTATEエラーコードを指定します。 errmsg呼び出しは主メッセージテキストを提供します。

また、補助関数の呼び出しを追加の括弧のセットで囲んだ、この古いスタイルもよく見ることでしょう。

ereport(ERROR,
        (errcode(ERRCODE_DIVISION_BY_ZERO),
         errmsg("division by zero")));

この余分な括弧はPostgreSQLバージョン12より前では必要でしたが、現在ではオプションです。

以下に、より複雑な例を示します。

ereport(ERROR,
        errcode(ERRCODE_AMBIGUOUS_FUNCTION),
        errmsg("function %s is not unique",
               func_signature_string(funcname, nargs,
                                     NIL, actual_arg_types)),
        errhint("Unable to choose a best candidate function. "
                "You might need to add explicit typecasts."));

これは、実行時の値をメッセージテキスト内に埋め込むための整形用コードの使用を示します。 また、省略可能なヒントメッセージも提供されています。 補助関数の呼び出しは任意の順序で記述できますが、慣習的にerrcodeerrmsgが最初に記述されます。

深刻度レベルがERROR以上であれば、ereportは現在の問い合わせの実行を中断し、呼び出し元には戻りません。 深刻度レベルがERROR未満であれば、ereportは正常に戻ります。

ereportで使用可能な補助ルーチンを以下に示します。

注記

ereport呼び出しにおいて、最大限でもerrtableerrtablecolerrtableconstrainterrdatatype、またはerrdomainconstraintのうちの一つの関数が使用されなければなりません。 これらの関数は、アプリケーションが自動エラー対応であって欲しいと期待するエラーレポートにおいて使用されるべきです。 PostgreSQL 9.3の時点で、この機能を完璧に保証する範囲はSQLSTATEクラス23(整合性制約違反)のみですが、将来的には十中八九拡張されそうです。

まだ頻繁に使用されている、古めのelog関数があります。 以下のelog呼び出しは、

elog(level, "format string", ...);

以下とまったく同じです。

ereport(level, errmsg_internal("format string", ...));

SQLSTATEエラーコードが常にデフォルトになること、メッセージ文字列が翻訳されないことに注意してください。 したがって、elogは、内部エラーと低レベルなデバッグ用ログにのみ使用すべきです。 一般ユーザを対象とする任意のメッセージはereportを使用すべきです。 それでもなお、システム内の発生できなかった内部エラーの検査にelogがまだ多く使用されています。 これは、こうした単純な表記のメッセージに適しています。

56.3に推奨するエラーメッセージの作成についての提言を示します。



[16] つまり、ereport呼び出しに達した時点の値です。 補助報告ルーチン内でerrnoを変更しても効果はありません。 errmsg内でstrerror(errno)を明示的に記述したとしても正確なものにはなりません。 したがって、このようにはしないでください。