9.29. イベントトリガ関数 #

PostgreSQLはイベントトリガについての情報を取得するために以下のヘルパ関数を提供しています。

イベントトリガについての詳細は第40章を参照して下さい。

9.29.1. コマンド側での変更を捕らえる #

pg_event_trigger_ddl_commands () → setof record

pg_event_trigger_ddl_commandsddl_command_endイベントトリガーに付与された関数から起動されると、各ユーザの操作によって実行されたDDLコマンドの一覧を返します。 それ以外の環境から呼び出された場合はエラーが発生します。 pg_event_trigger_ddl_commandsは、実行された基となるコマンドのそれぞれについて1行を返します。 1つのSQL文として実行されるいくつかのコマンドに対して、複数の行が返されることもあります。 この関数は以下の列を返します。

名前説明
classidoidオブジェクトが属するカタログのOID
objidoidカタログ内のオブジェクトのOID
objsubidintegerオブジェクトのサブID(例えば、列の列番号)
command_tagtextコマンドのタグ
object_typetextオブジェクトの型
schema_nametext オブジェクトが属するスキーマの名前(あれば)。 なければNULL。 引用符づけされない。
object_identitytext オブジェクトの識別をテキスト表現したもので、スキーマ修飾される。 識別内に存在する各識別子は、必要なら引用符で括られる。
in_extensionbooleanコマンドが拡張のスクリプトの一部なら真
commandpg_ddl_command コマンドを内部形式で完全に表現したもの。 これを直接出力することはできないが、コマンドについて他の情報を得るために、他の関数に渡すことができる。

9.29.2. DDLコマンドで削除されたオブジェクトの処理 #

pg_event_trigger_dropped_objects () → setof record

関数pg_event_trigger_dropped_objectsは、それが呼ばれたsql_dropイベントのコマンドにより削除された全てのオブジェクトのリストを返します。 それ以外の状況で呼ばれた場合、エラーが生じます。 この関数は以下の列を返します。

名前説明
classidoidオブジェクトが所属するカタログのOID
objidoidカタログ内に所有するオブジェクトのOID
objsubidintegerオブジェクトのサブID(例えば、列の列番号)
originalbooleanこれが削除のルートオブジェクトの一つなら真
normalboolean このオブジェクトへと至る依存関係グラフで、通常の依存があるなら真
is_temporaryboolean オブジェクトが一時オブジェクトであったなら真
object_typetextオブジェクトの型
schema_nametext オブジェクトが所属しているスキーマの名前(あれば)。 なければNULL。 引用符づけされない。
object_nametext スキーマと名前の組み合わせがオブジェクトに対する一意の識別子として使用可能な場合はオブジェクトの名前。そうでないときはNULL。 引用符は適用されず、名前は決してスキーマで修飾されない。
object_identitytext オブジェクト識別のテキスト表現で、スキーマ修飾される。 識別内に存在する各識別子は必要であれば引用符で括られる。
address_namestext[] object_typeおよびaddress_argsと一緒にpg_get_object_address()で使うことで、同じ種類で全く同じ名前のオブジェクトを含むリモートサーバ内のオブジェクトアドレスを再作成できる配列。
address_argstext[] address_namesの補足。

関数pg_event_trigger_dropped_objectsは以下のようにイベントトリガとして使用可能です。

CREATE FUNCTION test_event_trigger_for_drops()
        RETURNS event_trigger LANGUAGE plpgsql AS $$
DECLARE
    obj record;
BEGIN
    FOR obj IN SELECT * FROM pg_event_trigger_dropped_objects()
    LOOP
        RAISE NOTICE '% dropped object: % %.% %',
                     tg_tag,
                     obj.object_type,
                     obj.schema_name,
                     obj.object_name,
                     obj.object_identity;
    END LOOP;
END;
$$;
CREATE EVENT TRIGGER test_event_trigger_for_drops
   ON sql_drop
   EXECUTE FUNCTION test_event_trigger_for_drops();

9.29.3. テーブル書き換えイベントの処理 #

表 9.104に示す関数は、table_rewriteイベントが呼び出されたばかりのテーブルについての情報を提供します。 それ以外の状況で呼び出された場合はエラーが発生します。

表9.104 テーブル書き換え情報関数

関数

説明

pg_event_trigger_table_rewrite_oid () → oid

書き換えようとされているテーブルのOIDを返します。

pg_event_trigger_table_rewrite_reason () → integer

書き換えの理由を説明する理由コードを返します。 コードの正確な意味はリリースに依存します。


これらの関数はイベントトリガ中で次のように使用できます。

CREATE FUNCTION test_event_trigger_table_rewrite_oid()
 RETURNS event_trigger
 LANGUAGE plpgsql AS
$$
BEGIN
  RAISE NOTICE 'rewriting table % for reason %',
                pg_event_trigger_table_rewrite_oid()::regclass,
                pg_event_trigger_table_rewrite_reason();
END;
$$;

CREATE EVENT TRIGGER test_table_rewrite_oid
                  ON table_rewrite
   EXECUTE FUNCTION test_event_trigger_table_rewrite_oid();