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/plpgsql-errors-and-messages...

148 lines
13KB
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>42.9. Errors and Messages</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="plpgsql-transactions.html" title="42.8. Transaction Management" /><link rel="next" href="plpgsql-trigger.html" title="42.10. Trigger Functions" /></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">42.9. Errors and Messages</th></tr><tr><td width="10%" align="left"><a accesskey="p" href="plpgsql-transactions.html" title="42.8. Transaction Management">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="plpgsql.html" title="Chapter 42. PL/pgSQL - SQL Procedural Language">Up</a></td><th width="60%" align="center">Chapter 42. <span xmlns="http://www.w3.org/1999/xhtml" class="application">PL/pgSQL</span> - <acronym xmlns="http://www.w3.org/1999/xhtml" class="acronym">SQL</acronym> 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="plpgsql-trigger.html" title="42.10. Trigger Functions">Next</a></td></tr></table><hr></hr></div><div class="sect1" id="PLPGSQL-ERRORS-AND-MESSAGES"><div class="titlepage"><div><div><h2 class="title" style="clear: both">42.9. Errors and Messages</h2></div></div></div><div class="toc"><dl class="toc"><dt><span class="sect2"><a href="plpgsql-errors-and-messages.html#PLPGSQL-STATEMENTS-RAISE">42.9.1. Reporting Errors and Messages</a></span></dt><dt><span class="sect2"><a href="plpgsql-errors-and-messages.html#PLPGSQL-STATEMENTS-ASSERT">42.9.2. Checking Assertions</a></span></dt></dl></div><div class="sect2" id="PLPGSQL-STATEMENTS-RAISE"><div class="titlepage"><div><div><h3 class="title">42.9.1. Reporting Errors and Messages</h3></div></div></div><a id="id-1.8.8.11.2.2" class="indexterm"></a><a id="id-1.8.8.11.2.3" class="indexterm"></a><p>

  3.     Use the <code class="command">RAISE</code> statement to report messages and

  4.     raise errors.

  5. 

  6. </p><pre class="synopsis">

  7. RAISE [<span class="optional"> <em class="replaceable"><code>level</code></em> </span>] '<em class="replaceable"><code>format</code></em>' [<span class="optional">, <em class="replaceable"><code>expression</code></em> [<span class="optional">, ... </span>]</span>] [<span class="optional"> USING <em class="replaceable"><code>option</code></em> = <em class="replaceable"><code>expression</code></em> [<span class="optional">, ... </span>] </span>];

  8. RAISE [<span class="optional"> <em class="replaceable"><code>level</code></em> </span>] <em class="replaceable"><code>condition_name</code></em> [<span class="optional"> USING <em class="replaceable"><code>option</code></em> = <em class="replaceable"><code>expression</code></em> [<span class="optional">, ... </span>] </span>];

  9. RAISE [<span class="optional"> <em class="replaceable"><code>level</code></em> </span>] SQLSTATE '<em class="replaceable"><code>sqlstate</code></em>' [<span class="optional"> USING <em class="replaceable"><code>option</code></em> = <em class="replaceable"><code>expression</code></em> [<span class="optional">, ... </span>] </span>];

  10. RAISE [<span class="optional"> <em class="replaceable"><code>level</code></em> </span>] USING <em class="replaceable"><code>option</code></em> = <em class="replaceable"><code>expression</code></em> [<span class="optional">, ... </span>];

  11. RAISE ;

  12. </pre><p>

  13. 

  14.     The <em class="replaceable"><code>level</code></em> option specifies

  15.     the error severity.  Allowed levels are <code class="literal">DEBUG</code>,

  16.     <code class="literal">LOG</code>, <code class="literal">INFO</code>,

  17.     <code class="literal">NOTICE</code>, <code class="literal">WARNING</code>,

  18.     and <code class="literal">EXCEPTION</code>, with <code class="literal">EXCEPTION</code>

  19.     being the default.

  20.     <code class="literal">EXCEPTION</code> raises an error (which normally aborts the

  21.     current transaction); the other levels only generate messages of different

  22.     priority levels.

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

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

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

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

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

  28.     information.

  29.    </p><p>

  30.     After <em class="replaceable"><code>level</code></em> if any,

  31.     you can write a <em class="replaceable"><code>format</code></em>

  32.     (which must be a simple string literal, not an expression).  The

  33.     format string specifies the error message text to be reported.

  34.     The format string can be followed

  35.     by optional argument expressions to be inserted into the message.

  36.     Inside the format string, <code class="literal">%</code> is replaced by the

  37.     string representation of the next optional argument's value. Write

  38.     <code class="literal">%%</code> to emit a literal <code class="literal">%</code>.

  39.     The number of arguments must match the number of <code class="literal">%</code>

  40.     placeholders in the format string, or an error is raised during

  41.     the compilation of the function.

  42.    </p><p>

  43.     In this example, the value of <code class="literal">v_job_id</code> will replace the

  44.     <code class="literal">%</code> in the string:

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

  46. RAISE NOTICE 'Calling cs_create_job(%)', v_job_id;

  47. </pre><p>

  48.    </p><p>

  49.     You can attach additional information to the error report by writing

  50.     <code class="literal">USING</code> followed by <em class="replaceable"><code>option</code></em> = <em class="replaceable"><code>expression</code></em> items.  Each

  51.     <em class="replaceable"><code>expression</code></em> can be any

  52.     string-valued expression.  The allowed <em class="replaceable"><code>option</code></em> key words are:

  53. 

  54.     </p><div class="variablelist" id="RAISE-USING-OPTIONS"><dl class="variablelist"><dt><span class="term"><code class="literal">MESSAGE</code></span></dt><dd><p>Sets the error message text.  This option can't be used in the

  55.         form of <code class="command">RAISE</code> that includes a format string

  56.         before <code class="literal">USING</code>.</p></dd><dt><span class="term"><code class="literal">DETAIL</code></span></dt><dd><p>Supplies an error detail message.</p></dd><dt><span class="term"><code class="literal">HINT</code></span></dt><dd><p>Supplies a hint message.</p></dd><dt><span class="term"><code class="literal">ERRCODE</code></span></dt><dd><p>Specifies the error code (SQLSTATE) to report, either by condition

  57.         name, as shown in <a class="xref" href="errcodes-appendix.html" title="Appendix A. PostgreSQL Error Codes">Appendix A</a>, or directly as a

  58.         five-character SQLSTATE code.</p></dd><dt><span class="term"><code class="literal">COLUMN</code><br /></span><span class="term"><code class="literal">CONSTRAINT</code><br /></span><span class="term"><code class="literal">DATATYPE</code><br /></span><span class="term"><code class="literal">TABLE</code><br /></span><span class="term"><code class="literal">SCHEMA</code></span></dt><dd><p>Supplies the name of a related object.</p></dd></dl></div><p>

  59.    </p><p>

  60.     This example will abort the transaction with the given error message

  61.     and hint:

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

  63. RAISE EXCEPTION 'Nonexistent ID --&gt; %', user_id

  64.       USING HINT = 'Please check your user ID';

  65. </pre><p>

  66.    </p><p>

  67.     These two examples show equivalent ways of setting the SQLSTATE:

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

  69. RAISE 'Duplicate user ID: %', user_id USING ERRCODE = 'unique_violation';

  70. RAISE 'Duplicate user ID: %', user_id USING ERRCODE = '23505';

  71. </pre><p>

  72.    </p><p>

  73.     There is a second <code class="command">RAISE</code> syntax in which the main argument

  74.     is the condition name or SQLSTATE to be reported, for example:

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

  76. RAISE division_by_zero;

  77. RAISE SQLSTATE '22012';

  78. </pre><p>

  79.     In this syntax, <code class="literal">USING</code> can be used to supply a custom

  80.     error message, detail, or hint.  Another way to do the earlier

  81.     example is

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

  83. RAISE unique_violation USING MESSAGE = 'Duplicate user ID: ' || user_id;

  84. </pre><p>

  85.    </p><p>

  86.     Still another variant is to write <code class="literal">RAISE USING</code> or <code class="literal">RAISE

  87.     <em class="replaceable"><code>level</code></em> USING</code> and put

  88.     everything else into the <code class="literal">USING</code> list.

  89.    </p><p>

  90.     The last variant of <code class="command">RAISE</code> has no parameters at all.

  91.     This form can only be used inside a <code class="literal">BEGIN</code> block's

  92.     <code class="literal">EXCEPTION</code> clause;

  93.     it causes the error currently being handled to be re-thrown.

  94.    </p><div class="note"><h3 class="title">Note</h3><p>

  95.      Before <span class="productname">PostgreSQL</span> 9.1, <code class="command">RAISE</code> without

  96.      parameters was interpreted as re-throwing the error from the block

  97.      containing the active exception handler.  Thus an <code class="literal">EXCEPTION</code>

  98.      clause nested within that handler could not catch it, even if the

  99.      <code class="command">RAISE</code> was within the nested <code class="literal">EXCEPTION</code> clause's

  100.      block. This was deemed surprising as well as being incompatible with

  101.      Oracle's PL/SQL.

  102.     </p></div><p>

  103.     If no condition name nor SQLSTATE is specified in a

  104.     <code class="command">RAISE EXCEPTION</code> command, the default is to use

  105.     <code class="literal">ERRCODE_RAISE_EXCEPTION</code> (<code class="literal">P0001</code>).

  106.     If no message text is specified, the default is to use the condition

  107.     name or SQLSTATE as message text.

  108.    </p><div class="note"><h3 class="title">Note</h3><p>

  109.      When specifying an error code by SQLSTATE code, you are not

  110.      limited to the predefined error codes, but can select any

  111.      error code consisting of five digits and/or upper-case ASCII

  112.      letters, other than <code class="literal">00000</code>.  It is recommended that

  113.      you avoid throwing error codes that end in three zeroes, because

  114.      these are category codes and can only be trapped by trapping

  115.      the whole category.

  116.     </p></div></div><div class="sect2" id="PLPGSQL-STATEMENTS-ASSERT"><div class="titlepage"><div><div><h3 class="title">42.9.2. Checking Assertions</h3></div></div></div><a id="id-1.8.8.11.3.2" class="indexterm"></a><a id="id-1.8.8.11.3.3" class="indexterm"></a><a id="id-1.8.8.11.3.4" class="indexterm"></a><p>

  117.     The <code class="command">ASSERT</code> statement is a convenient shorthand for

  118.     inserting debugging checks into <span class="application">PL/pgSQL</span>

  119.     functions.

  120. 

  121. </p><pre class="synopsis">

  122. ASSERT <em class="replaceable"><code>condition</code></em> [<span class="optional"> , <em class="replaceable"><code>message</code></em> </span>];

  123. </pre><p>

  124. 

  125.     The <em class="replaceable"><code>condition</code></em> is a Boolean

  126.     expression that is expected to always evaluate to true; if it does,

  127.     the <code class="command">ASSERT</code> statement does nothing further.  If the

  128.     result is false or null, then an <code class="literal">ASSERT_FAILURE</code> exception

  129.     is raised.  (If an error occurs while evaluating

  130.     the <em class="replaceable"><code>condition</code></em>, it is

  131.     reported as a normal error.)

  132.    </p><p>

  133.     If the optional <em class="replaceable"><code>message</code></em> is

  134.     provided, it is an expression whose result (if not null) replaces the

  135.     default error message text <span class="quote">“<span class="quote">assertion failed</span>”</span>, should

  136.     the <em class="replaceable"><code>condition</code></em> fail.

  137.     The <em class="replaceable"><code>message</code></em> expression is

  138.     not evaluated in the normal case where the assertion succeeds.

  139.    </p><p>

  140.     Testing of assertions can be enabled or disabled via the configuration

  141.     parameter <code class="literal">plpgsql.check_asserts</code>, which takes a Boolean

  142.     value; the default is <code class="literal">on</code>.  If this parameter

  143.     is <code class="literal">off</code> then <code class="command">ASSERT</code> statements do nothing.

  144.    </p><p>

  145.     Note that <code class="command">ASSERT</code> is meant for detecting program

  146.     bugs, not for reporting ordinary error conditions.  Use

  147.     the <code class="command">RAISE</code> statement, described above, for that.

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