mirrors
/
postgres
mirror of https://github.com/postgres/postgres
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Here's some matching documentation, including some other 

undocumented items in TD.

Should doc patches alse be sent to pgsql-patches, or do I
have to subscribe to pgsql-docs?

The archive link for pgsql-patches is broken, and I don't
see any patches in spot checking the archive for pgsql-docs.

-Brad McLean.
This commit is contained in:
Bruce Momjian 2001-09-12 03:58:15 +00:00
parent 148f94b98f
commit 33a82e7fd8
1 changed files with 22 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
doc/src/sgml/plpython.sgml
View File

@ -1,4 +1,4 @@
<!-- $Header: /cvsroot/pgsql/doc/src/sgml/plpython.sgml,v 1.2 2001/09/10 21:58:47 petere Exp $ -->
<!-- $Header: /cvsroot/pgsql/doc/src/sgml/plpython.sgml,v 1.3 2001/09/12 03:58:15 momjian Exp $ -->
<chapter id="plpython">
<title>PL/Python - Python Procedural Language</title>
@ -58,13 +58,7 @@ def __plpython_procedure_myfunc_23456():
The global dictionary SD is available to store data between
function calls. This variable is private static data. The global
dictionary GD is public data, available to all python functions
within a backend. Use with care. When the function is used in a
trigger, the triggers tuples are in <literal>TD["new"]</literal> and/or <literal>TD["old"]</literal>
depending on the trigger event. Return 'None' or "OK" from the
python function to indicate the tuple is unmodified, "SKIP" to
abort the event, or "MODIFIED" to indicate you've modified the
tuple. If the trigger was called with arguments they are available
in <literal>TD["args"][0] to TD["args"][(n -1)]</literal>.
within a backend. Use with care.
</para>
<para>
@ -75,6 +69,26 @@ def __plpython_procedure_myfunc_23456():
dictionary, as mentioned above.
</para>
</para>
When a function is used in a trigger, the dictionary TD contains
transaction related values. The trigger tuples are in TD["new"]
and/or TD["old"] depending on the trigger event. TD["event"]
contains the event as a string ("INSERT", "UPDATE", "DELETE", or
"UNKNOWN"). TD["when"] contains one of ("BEFORE", "AFTER", or
"UNKNOWN"). TD["level"] contains one of ("ROW", "STATEMENT", or
"UNKNOWN"). TD["name"] contains the trigger name, and TD["relid"]
contains the relation id of the table on which the trigger occurred.
If the trigger was called with arguments they are available
in TD["args"][0] to TD["args"][(n -1)]
</para>
<para>
If the trigger 'when' is "BEFORE", you may Return 'None' or "OK"
from the python function to indicate the tuple is unmodified,
"SKIP" to abort the event, or "MODIFIED" to indicate you've
modified the tuple.
</para>
<para>
The PL/Python language module automatically imports a Python module
called <literal>plpy</literal>. The functions and constants in