Skip to content

Commit b7f3981

Browse files
danielgustafssondanielgustafsson
committed
doc: Use more concise wording for pl/pgSQL TG_ variables
To improve readability of the TG_ variables definition lists, this moves the datatypes up to the defined term to avoid having each entry start with "Data type". This also removes redundant wording that that didn't carry any information from the descriptions. Author: Christoph Berg <myon@debian.org> Reviewed-by: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org> Discussion: https://postgr.es/m/Yw4Noe3A2s87A0qq@msg.df7cb.de
1 parent 5b66de3 commit b7f3981

File tree

1 file changed

+28
-39
lines changed

1 file changed

+28
-39
lines changed

‎doc/src/sgml/plpgsql.sgml

+28-39
Original file line numberDiff line numberDiff line change
@@ -4032,129 +4032,120 @@ ASSERT <replaceable class="parameter">condition</replaceable> <optional> , <repl
40324032

40334033
<variablelist>
40344034
<varlistentry>
4035-
<term><varname>NEW</varname></term>
4035+
<term><varname>NEW</varname> <type>record</type></term>
40364036
<listitem>
40374037
<para>
4038-
Data type <type>RECORD</type>; variable holding the new
4039-
database row for <command>INSERT</command>/<command>UPDATE</command> operations in row-level
4038+
new database row for <command>INSERT</command>/<command>UPDATE</command> operations in row-level
40404039
triggers. This variable is null in statement-level triggers
40414040
and for <command>DELETE</command> operations.
40424041
</para>
40434042
</listitem>
40444043
</varlistentry>
40454044

40464045
<varlistentry>
4047-
<term><varname>OLD</varname></term>
4046+
<term><varname>OLD</varname> <type>record</type></term>
40484047
<listitem>
40494048
<para>
4050-
Data type <type>RECORD</type>; variable holding the old
4051-
database row for <command>UPDATE</command>/<command>DELETE</command> operations in row-level
4049+
old database row for <command>UPDATE</command>/<command>DELETE</command> operations in row-level
40524050
triggers. This variable is null in statement-level triggers
40534051
and for <command>INSERT</command> operations.
40544052
</para>
40554053
</listitem>
40564054
</varlistentry>
40574055

40584056
<varlistentry>
4059-
<term><varname>TG_NAME</varname></term>
4057+
<term><varname>TG_NAME</varname> <type>name</type></term>
40604058
<listitem>
40614059
<para>
4062-
Data type <type>name</type>; variable that contains the name of the trigger actually
4063-
fired.
4060+
name of the trigger which fired.
40644061
</para>
40654062
</listitem>
40664063
</varlistentry>
40674064

40684065
<varlistentry>
4069-
<term><varname>TG_WHEN</varname></term>
4066+
<term><varname>TG_WHEN</varname> <type>text</type></term>
40704067
<listitem>
40714068
<para>
4072-
Data type <type>text</type>; a string of
40734069
<literal>BEFORE</literal>, <literal>AFTER</literal>, or
40744070
<literal>INSTEAD OF</literal>, depending on the trigger's definition.
40754071
</para>
40764072
</listitem>
40774073
</varlistentry>
40784074

40794075
<varlistentry>
4080-
<term><varname>TG_LEVEL</varname></term>
4076+
<term><varname>TG_LEVEL</varname> <type>text</type></term>
40814077
<listitem>
40824078
<para>
4083-
Data type <type>text</type>; a string of either
4084-
<literal>ROW</literal> or <literal>STATEMENT</literal>
4079+
<literal>ROW</literal> or <literal>STATEMENT</literal>,
40854080
depending on the trigger's definition.
40864081
</para>
40874082
</listitem>
40884083
</varlistentry>
40894084

40904085
<varlistentry>
4091-
<term><varname>TG_OP</varname></term>
4086+
<term><varname>TG_OP</varname> <type>text</type></term>
40924087
<listitem>
40934088
<para>
4094-
Data type <type>text</type>; a string of
4089+
operation for which the trigger was fired:
40954090
<literal>INSERT</literal>, <literal>UPDATE</literal>,
4096-
<literal>DELETE</literal>, or <literal>TRUNCATE</literal>
4097-
telling for which operation the trigger was fired.
4091+
<literal>DELETE</literal>, or <literal>TRUNCATE</literal>.
40984092
</para>
40994093
</listitem>
41004094
</varlistentry>
41014095

41024096
<varlistentry>
4103-
<term><varname>TG_RELID</varname></term>
4097+
<term><varname>TG_RELID</varname> <type>oid</type> (references <link linkend="catalog-pg-class"><structname>pg_class</structname></link>.<structfield>oid</structfield>)</term>
41044098
<listitem>
41054099
<para>
4106-
Data type <type>oid</type>; the object ID of the table that caused the
4107-
trigger invocation.
4100+
object ID of the table that caused the trigger invocation.
41084101
</para>
41094102
</listitem>
41104103
</varlistentry>
41114104

41124105
<varlistentry>
4113-
<term><varname>TG_RELNAME</varname></term>
4106+
<term><varname>TG_RELNAME</varname> <type>name</type></term>
41144107
<listitem>
41154108
<para>
4116-
Data type <type>name</type>; the name of the table that caused the trigger
4109+
table that caused the trigger
41174110
invocation. This is now deprecated, and could disappear in a future
41184111
release. Use <literal>TG_TABLE_NAME</literal> instead.
41194112
</para>
41204113
</listitem>
41214114
</varlistentry>
41224115

41234116
<varlistentry>
4124-
<term><varname>TG_TABLE_NAME</varname></term>
4117+
<term><varname>TG_TABLE_NAME</varname> <type>name</type></term>
41254118
<listitem>
41264119
<para>
4127-
Data type <type>name</type>; the name of the table that
4128-
caused the trigger invocation.
4120+
table that caused the trigger invocation.
41294121
</para>
41304122
</listitem>
41314123
</varlistentry>
41324124

41334125
<varlistentry>
4134-
<term><varname>TG_TABLE_SCHEMA</varname></term>
4126+
<term><varname>TG_TABLE_SCHEMA</varname> <type>name</type></term>
41354127
<listitem>
41364128
<para>
4137-
Data type <type>name</type>; the name of the schema of the
4138-
table that caused the trigger invocation.
4129+
schema of the table that caused the trigger invocation.
41394130
</para>
41404131
</listitem>
41414132
</varlistentry>
41424133

41434134
<varlistentry>
4144-
<term><varname>TG_NARGS</varname></term>
4135+
<term><varname>TG_NARGS</varname> <type>integer</type></term>
41454136
<listitem>
41464137
<para>
4147-
Data type <type>integer</type>; the number of arguments given to the trigger
4138+
number of arguments given to the trigger
41484139
function in the <command>CREATE TRIGGER</command> statement.
41494140
</para>
41504141
</listitem>
41514142
</varlistentry>
41524143

41534144
<varlistentry>
4154-
<term><varname>TG_ARGV[]</varname></term>
4145+
<term><varname>TG_ARGV</varname> <type>text[]</type></term>
41554146
<listitem>
41564147
<para>
4157-
Data type array of <type>text</type>; the arguments from
4148+
arguments from
41584149
the <command>CREATE TRIGGER</command> statement.
41594150
The index counts from 0. Invalid
41604151
indexes (less than 0 or greater than or equal to <varname>tg_nargs</varname>)
@@ -4656,21 +4647,19 @@ CREATE TRIGGER emp_audit_del
46564647

46574648
<variablelist>
46584649
<varlistentry>
4659-
<term><varname>TG_EVENT</varname></term>
4650+
<term><varname>TG_EVENT</varname> <type>text</type></term>
46604651
<listitem>
46614652
<para>
4662-
Data type <type>text</type>; a string representing the event the
4663-
trigger is fired for.
4653+
event the trigger is fired for.
46644654
</para>
46654655
</listitem>
46664656
</varlistentry>
46674657

46684658
<varlistentry>
4669-
<term><varname>TG_TAG</varname></term>
4659+
<term><varname>TG_TAG</varname> <type>text</type></term>
46704660
<listitem>
46714661
<para>
4672-
Data type <type>text</type>; variable that contains the command tag
4673-
for which the trigger is fired.
4662+
command tag for which the trigger is fired.
46744663
</para>
46754664
</listitem>
46764665
</varlistentry>

0 commit comments

Comments
 (0)