From 708c05277e6e2a93e9ceb1e52fda5991cef8b545 Mon Sep 17 00:00:00 2001 From: Christoph Berg Date: Tue, 30 Aug 2022 15:09:39 +0200 Subject: [PATCH] plpgsql-trigger.html: Format TG_ variables as table Format list as table, and remove redundant clutter ("viarable holding...") that made the list hard to skim --- doc/src/sgml/plpgsql.sgml | 221 ++++++++++++++++++++------------------ 1 file changed, 114 insertions(+), 107 deletions(-) diff --git a/doc/src/sgml/plpgsql.sgml b/doc/src/sgml/plpgsql.sgml index cf387dfc3f..c73e81eff0 100644 --- a/doc/src/sgml/plpgsql.sgml +++ b/doc/src/sgml/plpgsql.sgml @@ -4028,142 +4028,149 @@ ASSERT condition , When a PL/pgSQL function is called as a trigger, several special variables are created automatically in the - top-level block. They are: + top-level block. They are listed in . + - - - NEW - + + <structname>TG_</structname> special trigger function variables + + + + + Variable Type + - Data type RECORD; variable holding the new - database row for INSERT/UPDATE operations in row-level - triggers. This variable is null in statement-level triggers - and for DELETE operations. + Description + + + + + + + + NEW record - - - - - OLD - - Data type RECORD; variable holding the old - database row for UPDATE/DELETE operations in row-level + new database row for INSERT/UPDATE operations in row-level triggers. This variable is null in statement-level triggers - and for INSERT operations. - - - + and for DELETE operations. + + - - TG_NAME - + + + OLD record + - Data type name; variable that contains the name of the trigger actually - fired. + old database row for UPDATE/DELETE operations in row-level + triggers. This variable is null in statement-level triggers and for INSERT + operations. + + + + + + TG_NAME name - - + + name of the trigger fired. + + - - TG_WHEN - + + + TG_WHEN text + - Data type text; a string of - BEFORE, AFTER, or + string BEFORE, AFTER, or INSTEAD OF, depending on the trigger's definition. - - - + + - - TG_LEVEL - + + + TG_LEVEL text + - Data type text; a string of either - ROW or STATEMENT - depending on the trigger's definition. + string ROW or STATEMENT depending + on the trigger's definition. + + + + + + TG_OP text - - - - - TG_OP - - Data type text; a string of - INSERT, UPDATE, + string INSERT, UPDATE, DELETE, or TRUNCATE telling for which operation the trigger was fired. - - - + + - - TG_RELID - - - Data type oid; the object ID of the table that caused the - trigger invocation. + + + TG_RELID oid + (references pg_class.oid) - - - - - TG_RELNAME - - Data type name; the name of the table that caused the trigger - invocation. This is now deprecated, and could disappear in a future - release. Use TG_TABLE_NAME instead. - - - + object ID of the table that caused the trigger invocation. + + - - TG_TABLE_NAME - - - Data type name; the name of the table that - caused the trigger invocation. + + + TG_RELNAME name - - - - - TG_TABLE_SCHEMA - - Data type name; the name of the schema of the - table that caused the trigger invocation. + name of the table that caused the trigger invocation. This is now + deprecated, and could disappear in a future release. Use + TG_TABLE_NAME instead. + + + + + + TG_TABLE_NAME name - - - - - TG_NARGS - - Data type integer; the number of arguments given to the trigger - function in the CREATE TRIGGER statement. + name of the table that caused the trigger invocation. + + + + + + TG_TABLE_SCHEMA name - - + + name of the schema of the table that caused the trigger invocation. + + - - TG_ARGV[] - + + + TG_NARGS integer + - Data type array of text; the arguments from - the CREATE TRIGGER statement. - The index counts from 0. Invalid - indexes (less than 0 or greater than or equal to tg_nargs) - result in a null value. + number of arguments given to the trigger function in the + CREATE TRIGGER statement. + + + + + + TG_ARGV text[] - - - - + + arguments from the CREATE TRIGGER statement. The + index counts from 0. Invalid indexes (less than 0 or greater than or + equal to tg_nargs) result in a null value. + + + + + +
A trigger function must return either NULL or a -- 2.35.1