6.3. ecpgの使い方

6.3.1. プリプロセッサ

プリプロセッサはecpgと呼ばれます。PostgreSQLのbin/ディレクトリにインストールされています。

6.3.2. ライブラリ

ecpgライブラリは、libecpg.aもしくはlibecpg.soと呼ばれます。さらに、このライブラリはPostgreSQLサーバーとの通信にlibpqライブラリを使用します。よって、プログラムを-lecpg -lpqというリンクオプションを使用してリンクする必要があります。

このライブラリはいくつか"隠された"メソッドを持っていて、とても便利な場合があります。

• ECPGdebug(int on, FILE *stream)――第1引数が0以外で渡された場合、デバッグログをonにします。デバッグログはstreamで実行されます。ほとんどのSQL文は引数と結果をログに出力します。

  最も重要な関数ECPGdoは、拡張された文字列（たとえばすべての引数用変数が挿入されたもの）とPostgreSQLサーバーからの結果の両方をログに出力します。これはSQL文のエラーを探すのにとても便利です。

• ECPGstatus() このメソッドはデータベースと接続されている場合TRUEを返し、それ以外はFALSEを返します。

6.3.3. エラー処理

PostgreSQLサーバーからのエラーを見つけるためにはファイルのincludeセクションに下記のような行を追加してください。

exec sql include sqlca; 

この一文は下記のようなsqlcaという名前の構造体と変数を定義します。

struct sqlca
{
 char sqlcaid[8];
 long sqlabc;
 long sqlcode;
 struct
 {
  int sqlerrml;
  char sqlerrmc[70];
 } sqlerrm;
 char sqlerrp[8];
 long sqlerrd[6];
 /* 0: 空                                            */
 /* 1: 処理されたタプルの OID（あるならば）          */
 /* 2: INSERT、UPDATE、DELTE で処理された行数        */
 /* 3: 空                                            */
 /* 4: 空                                            */
 /* 5: 空                                            */
 char sqlwarn[8];
 /* 0: 少なくともどれかが 'W'ならば'W'               */
 /* 1: 'W' ならば、少なくとも 1 つの文字列がホストの */
 /*    変数に保存されるときに切りつめられている      */
 /* 2: 空                                            */
 /* 3: 空                                            */
 /* 4: 空                                            */
 /* 5: 空                                            */
 /* 6: 空                                            */
 /* 7: 空                                            */
 char sqlext[8];
} sqlca;

もし上のSQL文でエラーが発生しなかった場合、sqlca.sqlcodeが0（ECPG_NO_ERROR）になります。もしsqlca.sqlcodeが0よりも小さい場合、データベース定義が与えられた問い合わせと合わないといった深刻なエラーです。もし0より大きい場合はテーブルが要求された行を含まないといった通常のエラーです。

sqlca.sqlerrm.sqlerrmcは、エラーを説明する文字列を持っています。その文字列はソースファイルの行数で終わります。

起こり得るエラーを以下に示します。