ecpgは、Cプログラム用の埋め込みSQLプリプロセッサです。 SQL呼び出しを特殊な関数呼び出しに置き換えることによって、埋め込みSQL文を含むCプログラムを、通常のCコードに変換します。 これにより、出力ファイルは、どのようなCコンパイラツールを使用しても処理することができます。
ecpgは、コマンドラインで指定される各入力ファイルを対応するCの出力ファイルに変換します。 入力ファイルに.pgcという拡張子を付けておくと、出力ファイル名の拡張子が.cに置き換えられるので便利です。 入力ファイルの拡張子が.pgcでない場合、そのファイルのフルネームの末尾に.cを追加したものが出力ファイル名となります。 出力ファイル名は、-oオプションによって上書きすることもできます。
このマニュアルページでは埋め込みSQL言語については説明しません。 第33章を参照してください。
ecpgは、以下のコマンドライン引数を受け付けます。
SQLコードから有効なCコードを自動的に生成します。 現在、このオプションはEXEC SQL TYPEに対して使用できます。
互換モードを設定します。 modeはINFORMIXもしくはINFORMIX_SEのどちらかを取ることができます。
Cプリプロセッサのシンボルを定義します。
同様にシステムインクルードファイルも解析します。
追加のインクルード用パスを指定します。 これは、EXEC SQL INCLUDEを使用してインクルードされるファイルを検索する際に使用されます。 デフォルトでは順に、.(現行ディレクトリ)、/usr/local/include、コンパイル時に定義されるPostgreSQLのインクルードディレクトリ(デフォルトでは/usr/local/pgsql/include)、/usr/includeです。
ecpgが全ての出力をfilenameに書き込むことを指定します。
実行時の動作を選択します。 以下のいずれかをoptionとして取ることができます。
指示子を使用せずにNULL値を表す特殊な値を使用します。 歴史的にこの方式を使用したデータベースが存在します。
すべての文を使用する前に準備します。 libecpgは準備済みの文のキャッシュを保持し、再実行される場合に文を再利用します。 キャッシュが満杯になった場合、libecpgは最も古い文を解放します。
互換性という理由でクエスチョンマークをプレースホルダとして許します。 これは長い間デフォルトとして使用されていました。
トランザクションの自動コミットを有効にします。 このモードでは、各SQLコマンドは明示的なトランザクションブロックの内部にない限り、自動的にコミットされます。 デフォルトのモードでは、EXEC SQL COMMITが発行された時にのみコマンドがコミットされます。
バージョンやインクルード用パスなどの補足情報を表示します。
ecpgのバージョンを表示し、終了します。
ecpgのコマンドライン引数の使用方法を表示し、終了します。
前処理されたCコードファイルをコンパイルする際、コンパイラはPostgreSQLのインクルードディレクトリ内にあるECPGヘッダファイルを検索できるようにしなければなりません。 そのため、コンパイラの呼び出し時に、-Iオプションを使用しなければならない可能性があります(例:-I/usr/local/pgsql/include)。
SQLが埋め込まれたCプログラムには、-L/usr/local/pgsql/lib -lecpgリンカオプションを使用するなどして、libecpgライブラリをリンクする必要があります。
使用するシステムにおいて上記の2つに対応するディレクトリを調べるには、pg_configを使用します。