Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
Watch 1
Star 0
Wiki 捐赠
gooderp18绿色标准版
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Tree: 0f75e31513
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '0f75e31513'
${ noResults }
Green_GoodERP18_FSJ_Standard/PostgreSQL/doc/postgresql/html/plpython-util.html

60 lines
7.1KB
Raw Blame History 

  1. <?xml version="1.0" encoding="UTF-8" standalone="no"?>

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>45.10. Utility Functions</title><link rel="stylesheet" type="text/css" href="stylesheet.css" /><link rev="made" href="pgsql-docs@lists.postgresql.org" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="prev" href="plpython-transactions.html" title="45.9. Transaction Management" /><link rel="next" href="plpython-envar.html" title="45.11. Environment Variables" /></head><body><div xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="5" align="center">45.10. Utility Functions</th></tr><tr><td width="10%" align="left"><a accesskey="p" href="plpython-transactions.html" title="45.9. Transaction Management">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="plpython.html" title="Chapter 45. PL/Python - Python Procedural Language">Up</a></td><th width="60%" align="center">Chapter 45. PL/Python - Python Procedural Language</th><td width="10%" align="right"><a accesskey="h" href="index.html" title="PostgreSQL 12.4 Documentation">Home</a></td><td width="10%" align="right"> <a accesskey="n" href="plpython-envar.html" title="45.11. Environment Variables">Next</a></td></tr></table><hr></hr></div><div class="sect1" id="PLPYTHON-UTIL"><div class="titlepage"><div><div><h2 class="title" style="clear: both">45.10. Utility Functions</h2></div></div></div><p>

  3.    The <code class="literal">plpy</code> module also provides the functions

  4.    </p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="literal">plpy.debug(<em class="replaceable"><code>msg, **kwargs</code></em>)</code></td></tr><tr><td><code class="literal">plpy.log(<em class="replaceable"><code>msg, **kwargs</code></em>)</code></td></tr><tr><td><code class="literal">plpy.info(<em class="replaceable"><code>msg, **kwargs</code></em>)</code></td></tr><tr><td><code class="literal">plpy.notice(<em class="replaceable"><code>msg, **kwargs</code></em>)</code></td></tr><tr><td><code class="literal">plpy.warning(<em class="replaceable"><code>msg, **kwargs</code></em>)</code></td></tr><tr><td><code class="literal">plpy.error(<em class="replaceable"><code>msg, **kwargs</code></em>)</code></td></tr><tr><td><code class="literal">plpy.fatal(<em class="replaceable"><code>msg, **kwargs</code></em>)</code></td></tr></table><p>

  5.    <a id="id-1.8.11.18.2.3" class="indexterm"></a>

  6.    <code class="function">plpy.error</code> and <code class="function">plpy.fatal</code>

  7.    actually raise a Python exception which, if uncaught, propagates out to

  8.    the calling query, causing the current transaction or subtransaction to

  9.    be aborted.  <code class="literal">raise plpy.Error(<em class="replaceable"><code>msg</code></em>)</code> and

  10.    <code class="literal">raise plpy.Fatal(<em class="replaceable"><code>msg</code></em>)</code> are

  11.    equivalent to calling <code class="literal">plpy.error(<em class="replaceable"><code>msg</code></em>)</code> and

  12.    <code class="literal">plpy.fatal(<em class="replaceable"><code>msg</code></em>)</code>, respectively but

  13.    the <code class="literal">raise</code> form does not allow passing keyword arguments.

  14.    The other functions only generate messages of different priority levels.

  15.    Whether messages of a particular priority are reported to the client,

  16.    written to the server log, or both is controlled by the

  17.    <a class="xref" href="runtime-config-logging.html#GUC-LOG-MIN-MESSAGES">log_min_messages</a> and

  18.    <a class="xref" href="runtime-config-client.html#GUC-CLIENT-MIN-MESSAGES">client_min_messages</a> configuration

  19.    variables. See <a class="xref" href="runtime-config.html" title="Chapter 19. Server Configuration">Chapter 19</a> for more information.

  20.   </p><p>

  21.    The <em class="replaceable"><code>msg</code></em> argument is given as a positional argument.  For

  22.    backward compatibility, more than one positional argument can be given. In

  23.    that case, the string representation of the tuple of positional arguments

  24.    becomes the message reported to the client.

  25.   </p><p>

  26.    The following keyword-only arguments are accepted:

  27.    </p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="literal">detail</code></td></tr><tr><td><code class="literal">hint</code></td></tr><tr><td><code class="literal">sqlstate</code></td></tr><tr><td><code class="literal">schema_name</code></td></tr><tr><td><code class="literal">table_name</code></td></tr><tr><td><code class="literal">column_name</code></td></tr><tr><td><code class="literal">datatype_name</code></td></tr><tr><td><code class="literal">constraint_name</code></td></tr></table><p>

  28.    The string representation of the objects passed as keyword-only arguments

  29.    is used to enrich the messages reported to the client. For example:

  30. 

  31. </p><pre class="programlisting">

  32. CREATE FUNCTION raise_custom_exception() RETURNS void AS $$

  33. plpy.error("custom exception message",

  34.            detail="some info about exception",

  35.            hint="hint for users")

  36. $$ LANGUAGE plpythonu;

  37. 

  38. =# SELECT raise_custom_exception();

  39. ERROR:  plpy.Error: custom exception message

  40. DETAIL:  some info about exception

  41. HINT:  hint for users

  42. CONTEXT:  Traceback (most recent call last):

  43.   PL/Python function "raise_custom_exception", line 4, in &lt;module&gt;

  44.     hint="hint for users")

  45. PL/Python function "raise_custom_exception"

  46. </pre><p>

  47.   </p><p>

  48.    Another set of utility functions are

  49.    <code class="literal">plpy.quote_literal(<em class="replaceable"><code>string</code></em>)</code>,

  50.    <code class="literal">plpy.quote_nullable(<em class="replaceable"><code>string</code></em>)</code>, and

  51.    <code class="literal">plpy.quote_ident(<em class="replaceable"><code>string</code></em>)</code>.  They

  52.    are equivalent to the built-in quoting functions described in <a class="xref" href="functions-string.html" title="9.4. String Functions and Operators">Section 9.4</a>.  They are useful when constructing

  53.    ad-hoc queries.  A PL/Python equivalent of dynamic SQL from <a class="xref" href="plpgsql-statements.html#PLPGSQL-QUOTE-LITERAL-EXAMPLE" title="Example 42.1. Quoting Values in Dynamic Queries">Example 42.1</a> would be:

  54. </p><pre class="programlisting">

  55. plpy.execute("UPDATE tbl SET %s = %s WHERE key = %s" % (

  56.     plpy.quote_ident(colname),

  57.     plpy.quote_nullable(newvalue),

  58.     plpy.quote_literal(keyvalue)))

  59. </pre><p>

  60.   </p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="plpython-transactions.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="plpython.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="plpython-envar.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">45.9. Transaction Management </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> 45.11. Environment Variables</td></tr></table></div></body></html>
上海开阖软件有限公司 沪ICP备12045867号-1