FDWオプションのようなFDW関連オブジェクトの属性に外部データラッパーの作者が簡単にアクセスできるように、いくつかのヘルパ関数がコアサーバからエクスポートされています。
これらの関数を使用するには、ヘッダファイルforeign/foreign.h
をあなたのソースファイルにインクルードする必要があります。
このヘッダはまたこれらの関数が返す構造体も定義しています。
ForeignDataWrapper * GetForeignDataWrapperExtended(Oid fdwid, bits16 flags);
この関数は、与えられたOIDの外部データラッパーに対してForeignDataWrapper
オブジェクトを返します。
ForeignDataWrapper
オブジェクトにはFDWの属性(詳しくはforeign/foreign.h
を参照)が含まれます。
flags
は追加的なオプション一式を示すビット毎にorを取ったビットマスクです。
ここにはFDW_MISSING_OK
値を指定できて、この場合、未定義オブジェクトに対するエラーの代わりに呼び出し元にNULL
結果が返されます。
ForeignDataWrapper * GetForeignDataWrapper(Oid fdwid);
この関数は指定されたOIDを持つ外部データラッパーのForeignDataWrapper
オブジェクトを返します。ForeignDataWrapper
オブジェクトはFDWのプロパティを含みます(詳細はforeign/foreign.h
を参照して下さい)。
ForeignServer * GetForeignServerExtended(Oid serverid, bits16 flags);
この関数は、与えられたOIDの外部サーバに対してForeignServer
オブジェクトを返します。
ForeignServer
オブジェクトにはサーバの属性(詳しくはforeign/foreign.h
を参照)が含まれます。
flags
は追加的なオプション一式を示すビット毎にorを取ったビットマスクです。
ここにはFSV_MISSING_OK
値を指定できて、この場合、未定義オブジェクトに対するエラーの代わりに呼び出し元にNULL
結果が返されます。
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を返し、それ以外の場合はエラーを発生させます。