[11/15開催: PostgreSQL Conference Japan 2019 参加受付中] 
他のバージョンの文書 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

57.3. 外部データラッパヘルパ関数

FDWオプションのようなFDW関連オブジェクトの属性に外部データラッパの作者が簡単にアクセスできるように、いくつかのヘルパ関数がコアサーバからエクスポートされています。 これらの関数を使用するには、ヘッダファイルforeign/foreign.hをあなたのソースファイルにインクルードする必要があります。 このヘッダはまたこれらの関数が返す構造体も定義しています。

ForeignDataWrapper *
GetForeignDataWrapper(Oid fdwid);

この関数は指定されたOIDを持つ外部データラッパのForeignDataWrapperオブジェクトを返します。ForeignDataWrapperオブジェクトはFDWのプロパティを含みます(詳細はforeign/foreign.hを参照して下さい)。

ForeignServer *
GetForeignServer(Oid serverid);

この関数は指定されたOIDを持つ外部サーバのForeignServerオブジェクトを返します。ForeignServerオブジェクトは外部サーバのプロパティを含みます(詳細はforeign/foreign.hを参照して下さい)。

UserMapping *
GetUserMapping(Oid userid, Oid serverid);

この関数は指定されたロールと指定された外部サーバのユーザマッピングのUserMappingオブジェクトを返します。(もし特定のユーザのマッピングがない場合は、PUBLICのためのマッピングを返すか、それもなければエラーを発生させます。) UserMappingオブジェクトはユーザマッピングのプロパティを含みます(詳細はforeign/foreign.hを参照して下さい)。

ForeignTable *
GetForeignTable(Oid relid);

この関数は指定されたOIDを持つ外部テーブルのForeignTableオブジェクトを返します。ForeignTableオブジェクトは外部テーブルのプロパティを含みます(詳細はforeign/foreign.hを参照して下さい)。

List *
GetForeignColumnOptions(Oid relid, AttrNumber attnum);

この関数は指定された外部テーブルOIDと属性番号に該当する列の列単位のFDWオプションをDefElemのリスト形式で返します。その列がオプションを持たない場合はNILが返ります。

いくつかのオブジェクト種別については、OIDベースのものに加えて名前ベースの検索関数もあります。

ForeignDataWrapper *
GetForeignDataWrapperByName(const char *name, bool missing_ok);

この関数は指定された名前の外部データラッパのForeignDataWrapperオブジェクトを返します。外部データラッパが見つからない場合は、missing_okがtrueの場合はNULLを返し、それ以外の場合はエラーを発生させます。

ForeignServer *
GetForeignServerByName(const char *name, bool missing_ok);

この関数は指定された名前の外部サーバのForeignServerオブジェクトを返します。外部サーバが見つからない場合は、missing_okがtrueの場合はNULLを返し、それ以外の場合はエラーを発生させます。