Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 8d2e9a9

Browse files
committed
doc: Put PL/pgSQL RAISE USING keywords into a list
Karl O. Pinc
1 parent 6919b7e commit 8d2e9a9

File tree

1 file changed

+38
-14
lines changed

1 file changed

+38
-14
lines changed

doc/src/sgml/plpgsql.sgml

+38-14
Original file line numberDiff line numberDiff line change
@@ -3288,20 +3288,44 @@ RAISE NOTICE 'Calling cs_create_job(%)', v_job_id;
32883288
You can attach additional information to the error report by writing
32893289
<literal>USING</> followed by <replaceable
32903290
class="parameter">option</replaceable> = <replaceable
3291-
class="parameter">expression</replaceable> items. The allowed
3292-
<replaceable class="parameter">option</replaceable> keywords are
3293-
<literal>MESSAGE</>, <literal>DETAIL</>, <literal>HINT</>, and
3294-
<literal>ERRCODE</>, while each <replaceable
3295-
class="parameter">expression</replaceable> can be any string-valued
3296-
expression.
3297-
<literal>MESSAGE</> sets the error message text (this option can't
3298-
be used in the form of <command>RAISE</> that includes a format
3299-
string before <literal>USING</>).
3300-
<literal>DETAIL</> supplies an error detail message, while
3301-
<literal>HINT</> supplies a hint message.
3302-
<literal>ERRCODE</> specifies the error code (SQLSTATE) to report,
3303-
either by condition name as shown in <xref linkend="errcodes-appendix">,
3304-
or directly as a five-character SQLSTATE code.
3291+
class="parameter">expression</replaceable> items. Each
3292+
<replaceable class="parameter">expression</replaceable> can be any
3293+
string-valued expression. The allowed <replaceable
3294+
class="parameter">option</replaceable> key words are:
3295+
3296+
<variablelist id="raise-using-options">
3297+
<varlistentry>
3298+
<term><literal>MESSAGE</literal></term>
3299+
<listitem>
3300+
<para>Sets the error message text. This option can't be used in the
3301+
form of <command>RAISE</> that includes a format string
3302+
before <literal>USING</>.</para>
3303+
</listitem>
3304+
</varlistentry>
3305+
3306+
<varlistentry>
3307+
<term><literal>DETAIL</literal></term>
3308+
<listitem>
3309+
<para>Supplies an error detail message.</para>
3310+
</listitem>
3311+
</varlistentry>
3312+
3313+
<varlistentry>
3314+
<term><literal>HINT</literal></term>
3315+
<listitem>
3316+
<para>Supplies a hint message.</para>
3317+
</listitem>
3318+
</varlistentry>
3319+
3320+
<varlistentry>
3321+
<term><literal>ERRCODE</literal></term>
3322+
<listitem>
3323+
<para>Specifies the error code (SQLSTATE) to report, either by condition
3324+
name, as shown in <xref linkend="errcodes-appendix">, or directly as a
3325+
five-character SQLSTATE code.</para>
3326+
</listitem>
3327+
</varlistentry>
3328+
</variablelist>
33053329
</para>
33063330

33073331
<para>

0 commit comments

Comments
 (0)