509 lines
36 KiB
HTML
509 lines
36 KiB
HTML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!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" lang="en-US" xml:lang="en-us">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<meta name="dc.language" scheme="rfc1766" content="en-us" />
|
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
|
<!-- US Government Users Restricted Rights -->
|
|
<!-- Use, duplication or disclosure restricted by -->
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
|
<meta name="dc.date" scheme="iso8601" content="2005-09-19" />
|
|
<meta name="copyright" content="(C) Copyright IBM Corporation 1998, 2006" />
|
|
<meta name="security" content="public" />
|
|
<meta name="Robots" content="index,follow"/>
|
|
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
|
|
<meta name="keywords" content="COMMENT statement, COMMENT, SQL statements,
|
|
in catalog table, comment, DISTINCT TYPE clause, FUNCTION clause,
|
|
PROCEDURE clause, INDEX clause, PACKAGE clause, TRIGGER clause, ALIAS clause,
|
|
COLUMN clause, SPECIFIC clause, in COMMENT statement, specific-name, commenting,
|
|
function, PARAMETER clause, procedure, SEQUENCE clause, TABLE clause, IS clause,
|
|
double-byte character" />
|
|
<title>COMMENT</title>
|
|
<link rel="stylesheet" type="text/css" href="ibmidwb.css" />
|
|
<link rel="stylesheet" type="text/css" href="ic.css" />
|
|
</head>
|
|
<body>
|
|
<a id="Top_Of_Page" name="Top_Of_Page"></a><!-- Java sync-link -->
|
|
<script language = "Javascript" src = "../rzahg/synch.js" type="text/javascript"></script>
|
|
|
|
|
|
<a name="xcomnt"></a>
|
|
<h2 id="xcomnt"><a href="rbafzmst02.htm#ToC_807">COMMENT</a></h2><a id="idx1519" name="idx1519"></a><a id="idx1520" name="idx1520"></a><a id="idx1521" name="idx1521"></a><a id="idx1522" name="idx1522"></a><a id="idx1523" name="idx1523"></a><a id="idx1524" name="idx1524"></a><a id="idx1525" name="idx1525"></a><a id="idx1526" name="idx1526"></a><a id="idx1527" name="idx1527"></a><a id="idx1528" name="idx1528"></a><a id="idx1529" name="idx1529"></a><a id="idx1530" name="idx1530"></a><a id="idx1531" name="idx1531"></a><a id="idx1532" name="idx1532"></a>
|
|
<a name="comnt"></a>
|
|
<p id="comnt">The COMMENT statement adds or replaces comments in the catalog
|
|
descriptions of various database objects.</p>
|
|
<a name="wq1144"></a>
|
|
<h3 id="wq1144"><a href="rbafzmst02.htm#ToC_808">Invocation</a></h3>
|
|
<p>This statement can be embedded in an application program or issued interactively.
|
|
It is an executable statement that can be dynamically prepared.</p>
|
|
<a name="wq1145"></a>
|
|
<h3 id="wq1145"><a href="rbafzmst02.htm#ToC_809">Authorization</a></h3>
|
|
<p>To comment on a table, view, alias, index, column, distinct type, package, or sequence,
|
|
the privileges held by the authorization ID of the statement must include
|
|
at least one of the following: </p>
|
|
<ul>
|
|
<li>For the table, view, alias, index, distinct type, package, or sequence in the
|
|
statement,
|
|
<ul>
|
|
<li>The ALTER privilege on the table, view, alias, index, distinct type, package,
|
|
or sequence, and</li>
|
|
<li>The system authority *EXECUTE on the library that contains the table,
|
|
view, alias, index, distinct type, package, or sequence</li></ul></li>
|
|
<li>Administrative authority</li></ul>
|
|
<p>To comment on a trigger, the privileges held by the authorization ID of
|
|
the statement must include at least one of the following: </p>
|
|
<ul>
|
|
<li>For the subject table of the trigger in the statement:
|
|
<ul>
|
|
<li>The ALTER privilege on the subject table, and</li>
|
|
<li>The system authority *EXECUTE on the library that contains the subject
|
|
table</li></ul></li>
|
|
<li>Administrative authority</li></ul>
|
|
<p>To comment on a function, the privileges held by the authorization ID of
|
|
the statement must include at least one of the following: </p>
|
|
<ul>
|
|
<li>For the SYSFUNCS catalog view:
|
|
<ul>
|
|
<li>The UPDATE privilege on the view</li>
|
|
<li>The system authority *EXECUTE on library QSYS2</li></ul></li>
|
|
<li>Administrative authority</li></ul>
|
|
<p>To comment on a procedure, the privileges held by the authorization ID
|
|
of the statement must include at least one of the following: </p>
|
|
<ul>
|
|
<li>For the SYSPROCS catalog view:
|
|
<ul>
|
|
<li>The UPDATE privilege on the view, and</li>
|
|
<li>The system authority *EXECUTE on library QSYS2</li></ul></li>
|
|
<li>Administrative authority</li></ul>
|
|
<p>To comment on a parameter, the privileges held by the authorization ID
|
|
of the statement must include at least one of the following: </p>
|
|
<ul>
|
|
<li>For the SYSPARMS catalog table:
|
|
<ul>
|
|
<li>The UPDATE privilege on the table, and</li>
|
|
<li>The system authority *EXECUTE on library QSYS2</li></ul></li>
|
|
<li>Administrative authority</li></ul>
|
|
<p>To comment on a sequence, the privileges held by the authorization ID of
|
|
the statement must also include at least one of the following: </p>
|
|
<ul>
|
|
<li>*USE authority to the Change Data Area (CHGDTAARA), CL command</li>
|
|
<li>Administrative authority</li></ul>
|
|
<p>For information on the system authorities corresponding to SQL privileges,
|
|
see <a href="rbafzmstgnt.htm#eqtablet">Corresponding System Authorities When Checking Privileges to a Table or View</a>, <a href="rbafzmstgntudtp.htm#eqtabled">Corresponding System Authorities When Checking Privileges to a Distinct Type</a>, <a href="rbafzmstgntseqp.htm#eqtables">Corresponding System Authorities When Checking Privileges to a Sequence</a>,
|
|
and <a href="rbafzmstgntpp.htm#eqtablep">Corresponding System Authorities When Checking Privileges to a Package</a>.</p>
|
|
<a name="wq1146"></a>
|
|
<h3 id="wq1146"><a href="rbafzmst02.htm#ToC_810">Syntax</a></h3>
|
|
<a href="rbafzmstcomnt.htm#aliasdes"><img src="c.gif" alt="Click to skip syntax diagram" /></a>
|
|
<a name="wq1147"></a>
|
|
<div class="fignone" id="wq1147">
|
|
<pre class="cgraphic"><span><img src="c.gif" alt="Read syntax diagram" longdesc="rbafzmstsyn262.htm"
|
|
border="0" /></span><a href="#skipsyn-261"><img src="c.gif" alt="Skip visual syntax diagram"
|
|
border="0" /></a>>>-COMMENT--ON-------------------------------------------------->
|
|
|
|
>--+-+-ALIAS--<span class="italic">alias-name</span>----------------------------------------------------+--IS--<span class="italic">string-constant</span>-+-><
|
|
| +-COLUMN--+-<span class="italic">table-name.column-name</span>-+-----------------------------------+ |
|
|
| | '-<span class="italic">view-name.column-name</span>--' | |
|
|
| +-+----------+--TYPE--<span class="italic">distinct-type-name</span>-------------------------------+ |
|
|
| | '-DISTINCT-' | |
|
|
| +-+-+-FUNCTION-+--<span class="italic">function-name</span>--+------------------------------+-+----+ |
|
|
| | | '-ROUTINE--' '-(--+--------------------+--)-' | | |
|
|
| | | | .-,--------------. | | | |
|
|
| | | | V | | | | |
|
|
| | | '---<span class="italic">parameter-type</span>-+-' | | |
|
|
| | '-SPECIFIC--+-FUNCTION-+--<span class="italic">specific-name</span>-------------------------' | |
|
|
| | '-ROUTINE--' | |
|
|
| +-INDEX--<span class="italic">index-name</span>----------------------------------------------------+ |
|
|
| +-PACKAGE--<span class="italic">package-name</span>--+-------------------------+-------------------+ |
|
|
| | | .-VERSION-. | | |
|
|
| | '-+---------+--<span class="italic">version-id</span>-' | |
|
|
| +-PARAMETER--+-<span class="italic">routine-name.parameter-name</span>---------------------------+-+ |
|
|
| | '-SPECIFIC--+-FUNCTION--+--<span class="italic">specific-name.parameter-name</span>-' | |
|
|
| | +-PROCEDURE-+ | |
|
|
| | '-ROUTINE---' | |
|
|
| +-+-+-PROCEDURE-+--<span class="italic">procedure-name</span>--+------------------------------+-+--+ |
|
|
| | | '-ROUTINE---' '-(--+--------------------+--)-' | | |
|
|
| | | | .-,--------------. | | | |
|
|
| | | | V | | | | |
|
|
| | | '---<span class="italic">parameter-type</span>-+-' | | |
|
|
| | '-SPECIFIC--+-PROCEDURE-+--<span class="italic">specific-name</span>--------------------------' | |
|
|
| | '-ROUTINE---' | |
|
|
| +-SEQUENCE--<span class="italic">sequence-name</span>----------------------------------------------+ |
|
|
| +-TABLE--+-<span class="italic">table-name</span>-+------------------------------------------------+ |
|
|
| | '-<span class="italic">view-name</span>--' | |
|
|
| '-TRIGGER--<span class="italic">trigger-name</span>------------------------------------------------' |
|
|
+-<span><span class="italic">multiple-column-list</span></span>--------------------------------------------------------------------------+
|
|
'-<span><span class="italic">multiple-parameter-list</span></span>-----------------------------------------------------------------------'
|
|
|
|
</pre>
|
|
<a name="skipsyn-261" id="skipsyn-261"></a></div>
|
|
<a name="wq1148"></a>
|
|
<div class="fignone" id="wq1148">
|
|
<pre class="cgraphic"><span><img src="c.gif" alt="Read syntax diagram" longdesc="rbafzmstsyn263.htm"
|
|
border="0" /></span><a href="#skipsyn-262"><img src="c.gif" alt="Skip visual syntax diagram"
|
|
border="0" /></a><span>multiple-column-list:</span>
|
|
|
|
.-,--------------------------------.
|
|
.-COLUMN-. V |
|
|
|--+--------+--+-<span class="italic">table-name</span>-+--(----<span class="italic">column-name</span>--IS--<span class="italic">string-constant</span>-+--)--|
|
|
'-<span class="italic">view-name</span>--'
|
|
|
|
<span>multiple-parameter-list:</span>
|
|
|
|
|--PARAMETER--+-SPECIFIC--+-FUNCTION--+--<span class="italic">specific-name</span>------------------------+-->
|
|
| +-PROCEDURE-+ |
|
|
| '-ROUTINE---' |
|
|
| .-ROUTINE---. |
|
|
'-+-----------+--<span class="italic">routine-name</span>--+------------------------------+-'
|
|
+-FUNCTION--+ '-(--+--------------------+--)-'
|
|
'-PROCEDURE-' | .-,--------------. |
|
|
| V | |
|
|
'---<span class="italic">parameter-type</span>-+-'
|
|
|
|
.-,-----------------------------------.
|
|
V |
|
|
>--(----<span class="italic">parameter-name</span>--IS--<span class="italic">string-constant</span>-+--)----------------|
|
|
|
|
parameter-type:
|
|
|
|
|----<span class="italic">data-type</span>--+------------+----------------------------------|
|
|
'-AS LOCATOR-'
|
|
|
|
data-type:
|
|
|
|
|--+-<span class="italic">built-in-type</span>------+---------------------------------------|
|
|
'-<span class="italic">distinct-type-name</span>-'
|
|
|
|
</pre>
|
|
<a name="skipsyn-262" id="skipsyn-262"></a></div>
|
|
<a name="wq1149"></a>
|
|
<div class="fignone" id="wq1149">
|
|
<pre class="cgraphic"><span><img src="c.gif" alt="Read syntax diagram" longdesc="rbafzmstsyn264.htm"
|
|
border="0" /></span><a href="#skipsyn-263"><img src="c.gif" alt="Skip visual syntax diagram"
|
|
border="0" /></a>built-in-type:
|
|
|
|
|--+-+---SMALLINT---+----------------------------------------------------------------------------------------------+--|
|
|
| +-+-INTEGER-+--+ |
|
|
| | '-INT-----' | |
|
|
| '---BIGINT-----' |
|
|
| .-(5,0)----------------------------. |
|
|
+-+-+-DECIMAL-+-+--+----------------------------------+---------------------------------------------------------+
|
|
| | '-DEC-----' | '-(--+------------------------+--)-' |
|
|
| '-NUMERIC-----' '-<span class="italic">integer</span>--+-----------+-' |
|
|
| '-<span class="italic">, integer</span>-' |
|
|
| .-(53)----------. |
|
|
+-+-FLOAT--+---------------+-+----------------------------------------------------------------------------------+
|
|
| | '-(--<span class="italic">integer</span>--)-' | |
|
|
| +-REAL---------------------+ |
|
|
| | .-PRECISION-. | |
|
|
| '-DOUBLE--+-----------+----' |
|
|
| .-(1)---------------. |
|
|
+-+-+-+-CHARACTER-+--+-------------------+--------------+--+----------------+---------------------------------+-+
|
|
| | | '-CHAR------' '-(--+---------+--)-' | +-FOR BIT DATA---+ | |
|
|
| | | '-<span class="italic">integer</span>-' | +-FOR SBCS DATA--+ | |
|
|
| | '---+-+-CHARACTER-+--VARYING-+--(--+---------+--)---' +-FOR MIXED DATA-+ | |
|
|
| | | '-CHAR------' | '-<span class="italic">integer</span>-' '-CCSID--<span class="italic">integer</span>-' | |
|
|
| | '-VARCHAR----------------' | |
|
|
| | .-(1M)---------------------. | |
|
|
| '-----+-+-<span>CHARACTER</span>-+--<span>LARGE OBJECT</span>-+------+--------------------------+--+----------------+--+------------+-' |
|
|
| | '-<span>CHAR</span>------' | '-(--+---------+--+---+--)-' +-FOR SBCS DATA--+ '-AS LOCATOR-' |
|
|
| '-<span>CLOB</span>------------------------' '-<span class="italic">integer</span>-' +-K-+ +-FOR MIXED DATA-+ |
|
|
| +-M-+ '-CCSID--<span class="italic">integer</span>-' |
|
|
| '-G-' |
|
|
| .-(1)---------------. |
|
|
+-+-+---GRAPHIC----+-------------------+---------+--+----------------+-----------+------------------------------+
|
|
| | | '-(--+---------+--)-' | '-CCSID--<span class="italic">integer</span>-' | |
|
|
| | | '-<span class="italic">integer</span>-' | | |
|
|
| | '---+-VARGRAPHIC------+--(--+---------+--)---' | |
|
|
| | '-GRAPHIC VARYING-' '-<span class="italic">integer</span>-' | |
|
|
| | .-(1M)---------------------. | |
|
|
| '---DBCLOB----+--------------------------+--+----------------+--+------------+-' |
|
|
| '-(--+---------+--+---+--)-' '-CCSID--<span class="italic">integer</span>-' '-AS LOCATOR-' |
|
|
| '-<span class="italic">integer</span>-' +-K-+ |
|
|
| +-M-+ |
|
|
| '-G-' |
|
|
| .-(1)---------------. |
|
|
+-+-+-BINARY--+-------------------+---------+---------------------------------+---------------------------------+
|
|
| | | '-(--+---------+--)-' | | |
|
|
| | | '-<span class="italic">integer</span>-' | | |
|
|
| | '-+-BINARY VARYING-+--(--+---------+--)-' | |
|
|
| | '-VARBINARY------' '-<span class="italic">integer</span>-' | |
|
|
| | .-(1M)---------------------. | |
|
|
| '---+-BLOB----------------+----+--------------------------+--+------------+-' |
|
|
| '-BINARY LARGE OBJECT-' '-(--+---------+--+---+--)-' '-AS LOCATOR-' |
|
|
| '-<span class="italic">integer</span>-' +-K-+ |
|
|
| +-M-+ |
|
|
| '-G-' |
|
|
+-+---DATE-----------------+------------------------------------------------------------------------------------+
|
|
| | .-(--0--)-. | |
|
|
| +-TIME--+---------+------+ |
|
|
| | .-(--6--)-. | |
|
|
| '-TIMESTAMP--+---------+-' |
|
|
| .-(200)-------------. |
|
|
+---DATALINK--+-------------------+--+----------------+---------------------------------------------------------+
|
|
| '-(--+---------+--)-' '-CCSID--<span class="italic">integer</span>-' |
|
|
| '-<span class="italic">integer</span>-' |
|
|
'---ROWID-------------------------------------------------------------------------------------------------------'
|
|
|
|
</pre>
|
|
<a name="skipsyn-263" id="skipsyn-263"></a></div>
|
|
<a name="aliasdes"></a>
|
|
<h3 id="aliasdes"><a href="rbafzmst02.htm#ToC_811">Description</a></h3>
|
|
<dl class="parml">
|
|
<dt class="bold">ALIAS <var class="pv">alias-name</var></dt><a id="idx1533" name="idx1533"></a>
|
|
<dd>Identifies the alias to which the comment applies. The <var class="pv">alias-name</var> must identify an alias that exists at the current server.
|
|
</dd>
|
|
<dt class="bold">COLUMN </dt><a id="idx1534" name="idx1534"></a>
|
|
<dd>Specifies that a comment will be added to or replaced for a column.
|
|
<dl class="parml">
|
|
<dt class="bold"><var class="pv">table-name.column-name</var> <span class="base">or</span> <var class="pv">view-name.column-name</var></dt>
|
|
<dd>Identifies the column to which the comment applies. The <var class="pv">table-name</var> or <var class="pv">view-name</var> must identify a table or view that exists at the
|
|
current server, but must not identify a global temporary table. The <var class="pv">column-name</var> must identify a column of that table or view.
|
|
</dd>
|
|
</dl>
|
|
</dd>
|
|
<dt class="bold"> DISTINCT TYPE <var class="pv">distinct-type-name</var></dt><a id="idx1535" name="idx1535"></a>
|
|
<dd>Identifies the distinct type to which the comment applies. The <var class="pv">distinct-type-name</var> must identify a distinct type that exists at the current server.
|
|
</dd>
|
|
<dt class="bold">FUNCTION or SPECIFIC FUNCTION</dt><a id="idx1536" name="idx1536"></a>
|
|
<dd>Identifies the function on which the comment applies. The function must
|
|
exist at the current server and it must be a user-defined function. The function
|
|
can be identified by its name, function signature, or specific name.
|
|
<dl class="parml">
|
|
<dt class="bold">FUNCTION <var class="pv">function-name</var> </dt>
|
|
<dd>Identifies the function by its name. The <span class="italic">function-name</span> must identify exactly one function. The function may have any number
|
|
of parameters defined for it. If there is more than one function of the specified
|
|
name in the specified or implicit schema, an error is returned.
|
|
</dd>
|
|
<dt class="bold">FUNCTION <var class="pv">function-name (parameter-type, ...)</var></dt>
|
|
<dd>Identifies the function by its function signature, which uniquely identifies
|
|
the function. The <span class="italic">function-name (parameter-type, ...)</span> must identify a function with the specified function signature. The
|
|
specified parameters must match the data types in the corresponding position
|
|
that were specified when the function was created. The number of data types,
|
|
and the logical concatenation of the data types is used to identify the specific
|
|
function instance on which to comment. Synonyms for data types are considered
|
|
a match.
|
|
<p>If <var class="pv">function-name ()</var> is specified, the function identified
|
|
must have zero parameters.</p>
|
|
<dl class="parml">
|
|
<dt class="bold"><var class="pv">function-name </var></dt>
|
|
<dd>Identifies the name of the function.
|
|
</dd>
|
|
<dt class="bold"><var class="pv">(parameter-type, ...)</var></dt>
|
|
<dd>Identifies the parameters of the function.
|
|
<p>If an unqualified distinct
|
|
type name is specified, the database manager searches the SQL path to resolve the schema
|
|
name for the distinct type.</p>
|
|
<p>For data types that have a length, precision,
|
|
or scale attribute, use one of the following:</p>
|
|
<ul>
|
|
<li>Empty parentheses indicate that the database manager ignores the attribute when determining
|
|
whether the data types match. For example, DEC() will be considered a match
|
|
for a parameter of a function defined with a data type of DEC(7,2). However,
|
|
FLOAT cannot be specified with empty parenthesis because its parameter value
|
|
indicates a specific data type (REAL or DOUBLE).</li>
|
|
<li>If a specific value for a length, precision, or scale attribute is specified,
|
|
the value must exactly match the value that was specified (implicitly or explicitly)
|
|
in the CREATE FUNCTION statement. If the data type is FLOAT, the precision
|
|
does not have to exactly match the value that was specified because matching
|
|
is based on the data type (REAL or DOUBLE).</li>
|
|
<li>If length, precision, or scale is not explicitly specified, and empty
|
|
parentheses are not specified, the default attributes of the data type are
|
|
implied. The implicit length must exactly match the value that was specified
|
|
(implicitly or explicitly) in the CREATE FUNCTION statement.</li></ul>
|
|
<p>Specifying the FOR DATA clause or CCSID clause is optional. Omission
|
|
of either clause indicates that the database manager ignores the attribute when determining
|
|
whether the data types match. If either clause is specified, it must match
|
|
the value that was implicitly or explicitly specified in the CREATE FUNCTION
|
|
statement.</p>
|
|
</dd>
|
|
<dt class="bold">AS LOCATOR</dt>
|
|
<dd>Specifies that the function is defined to receive a locator for this
|
|
parameter. If AS LOCATOR is specified, the data type must be a LOB or a distinct
|
|
type based on a LOB. If AS LOCATOR is specified, FOR SBCS DATA or FOR MIXED
|
|
DATA must not be specified.
|
|
</dd>
|
|
</dl>
|
|
</dd>
|
|
<dt class="bold">SPECIFIC FUNCTION <var class="pv">specific-name</var> <a id="idx1537" name="idx1537"></a></dt><a id="idx1538" name="idx1538"></a><a id="idx1539" name="idx1539"></a>
|
|
<dd>Identifies the function by its specific name. The <span class="italic">specific-name</span> must identify a specific function that exists at the current
|
|
server.
|
|
</dd>
|
|
</dl>
|
|
</dd>
|
|
<dt class="bold">INDEX <var class="pv">index-name</var></dt><a id="idx1540" name="idx1540"></a>
|
|
<dd>Identifies the index to which the comment applies. The <span class="italic">index-name</span> must identify an index that exists at the current server.
|
|
</dd>
|
|
<dt class="bold">PACKAGE <var class="pv">package-name</var></dt>
|
|
<dd>Identifies the package to which the comment applies. The <span class="italic">package-name</span> must identify a package that exists at the current server. <sup class="fn"><a id="wq1150" name="wq1150" href="rbafzmstcomnt.htm#wq1151">60</a></sup>
|
|
<dl class="parml">
|
|
<dt class="bold">VERSION <var class="pv">version-id</var></dt>
|
|
<dd><var class="pv">version-id</var> is the version identifier that was assigned to the
|
|
package when it was created. If <var class="pv">version-id</var> is not specified, a null
|
|
string is used as the version identifier.
|
|
</dd>
|
|
</dl>
|
|
</dd>
|
|
<dt class="bold">PARAMETER </dt><a id="idx1541" name="idx1541"></a>
|
|
<dd>Specifies that a comment will be added to or replaced for a parameter.
|
|
<dl class="parml">
|
|
<dt class="bold"><var class="pv">routine-name.parameter-name</var></dt>
|
|
<dd>Identifies the parameter to which the comment applies. The parameter
|
|
could be for a procedure or a function. The <var class="pv">routine-name</var> must identify
|
|
a procedure or function that exists at the current server, and the <var class="pv">parameter-name</var> must identify a parameter of that procedure or function.
|
|
</dd>
|
|
<dt class="bold"><var class="pv">specific-name.parameter-name</var></dt>
|
|
<dd>Identifies the parameter to which the comment applies. The parameter
|
|
could be for a procedure or a function. The <var class="pv">specific-name</var> must identify
|
|
a procedure or function that exists at the current server, and the <var class="pv">parameter-name</var> must identify a parameter of that procedure or function.
|
|
</dd>
|
|
</dl>
|
|
</dd>
|
|
<dt class="bold">PROCEDURE or SPECIFIC PROCEDURE</dt>
|
|
<dd>Identifies the procedure to which the comment applies. The <span class="italic">procedure-name</span> must identify a procedure that exists at the current server.
|
|
<dl class="parml">
|
|
<dt class="bold">PROCEDURE <var class="pv">procedure-name</var> </dt>
|
|
<dd>Identifies the procedure by its name. The <span class="italic">procedure-name</span> must identify exactly one procedure. The procedure may have any number
|
|
of parameters defined for it. If there is more than one procedure of the specified
|
|
name in the specified or implicit schema, an error is returned.
|
|
</dd>
|
|
<dt class="bold">PROCEDURE <var class="pv">procedure-name (parameter-type, ...)</var></dt>
|
|
<dd>Identifies the procedure by its procedure signature, which uniquely
|
|
identifies the procedure. The <span class="italic">procedure-name (parameter-type,
|
|
...)</span> must identify a procedure with the specified procedure signature.
|
|
The specified parameters must match the data types in the corresponding position
|
|
that were specified when the procedure was created. The number of data types,
|
|
and the logical concatenation of the data types is used to identify the specific
|
|
procedure instance which is to be commented on. Synonyms for data types are
|
|
considered a match.
|
|
<p>If <var class="pv">procedure-name ()</var> is specified, the procedure
|
|
identified must have zero parameters.</p>
|
|
<dl class="parml">
|
|
<dt class="bold"><var class="pv">procedure-name </var></dt>
|
|
<dd>Identifies the name of the procedure.
|
|
</dd>
|
|
<dt class="bold"><var class="pv">(parameter-type, ...)</var></dt>
|
|
<dd>Identifies the parameters of the procedure.
|
|
<p>If an unqualified distinct
|
|
type name is specified, the database manager searches the SQL path to resolve the schema
|
|
name for the distinct type.</p>
|
|
<p>For data types that have a length, precision,
|
|
or scale attribute, use one of the following:</p>
|
|
<ul>
|
|
<li>Empty parentheses indicate that the database manager ignores the attribute when determining
|
|
whether the data types match. For example, DEC() will be considered a match
|
|
for a parameter of a procedure defined with a data type of DEC(7,2). However,
|
|
FLOAT cannot be specified with empty parenthesis because its parameter value
|
|
indicates a specific data type (REAL or DOUBLE).</li>
|
|
<li>If a specific value for a length, precision, or scale attribute is specified,
|
|
the value must exactly match the value that was specified (implicitly or explicitly)
|
|
in the CREATE PROCEDURE statement. If the data type is FLOAT, the precision
|
|
does not have to exactly match the value that was specified because matching
|
|
is based on the data type (REAL or DOUBLE).</li>
|
|
<li>If length, precision, or scale is not explicitly specified, and empty
|
|
parentheses are not specified, the default attributes of the data type are
|
|
implied. The implicit length must exactly match the value that was specified
|
|
(implicitly or explicitly) in the CREATE PROCEDURE statement.</li></ul>
|
|
<p>Specifying the FOR DATA clause or CCSID clause is optional. Omission
|
|
of either clause indicates that the database manager ignores the attribute when determining
|
|
whether the data types match. If either clause is specified, it must match
|
|
the value that was implicitly or explicitly specified in the CREATE PROCEDURE
|
|
statement.</p>
|
|
</dd>
|
|
<dt class="bold">AS LOCATOR</dt>
|
|
<dd>Specifies that the procedure is defined to receive a locator for this
|
|
parameter. If AS LOCATOR is specified, the data type must be a LOB or a distinct
|
|
type based on a LOB. If AS LOCATOR is specified, FOR SBCS DATA or FOR MIXED
|
|
DATA must not be specified.
|
|
</dd>
|
|
</dl>
|
|
</dd>
|
|
<dt class="bold">SPECIFIC PROCEDURE <var class="pv">specific-name</var> </dt><a id="idx1542" name="idx1542"></a><a id="idx1543" name="idx1543"></a><a id="idx1544" name="idx1544"></a>
|
|
<dd>Identifies the procedure by its specific name. The <span class="italic">specific-name</span> must identify a specific procedure that exists at the current
|
|
server.
|
|
</dd>
|
|
</dl>
|
|
</dd>
|
|
<dt class="bold">SEQUENCE <var class="pv">sequence-name</var></dt><a id="idx1545" name="idx1545"></a>
|
|
<dd>Identifies the sequence to which the comment applies. The <span class="italic">sequence-name</span> must identify a sequence that exists at the current server.
|
|
</dd>
|
|
<dt class="bold">TABLE <var class="pv">table-name</var><span class="base"> or </span> <var class="pv">view-name</var></dt><a id="idx1546" name="idx1546"></a>
|
|
<dd>Identifies the table or view to which the comment applies. The <span class="italic">table-name</span> or <span class="italic">view-name</span> must identify a table
|
|
or view that exists at the current server, but must not identify a global
|
|
temporary table.
|
|
</dd>
|
|
<dt class="bold">TRIGGER <var class="pv">trigger-name</var></dt><a id="idx1547" name="idx1547"></a>
|
|
<dd>Identifies the trigger to which the comment applies. The <span class="italic">trigger-name</span> must identify a trigger that exists at the current server.
|
|
</dd>
|
|
<dt class="bold">IS <a id="idx1548" name="idx1548"></a></dt>
|
|
<dd>Introduces the comment that to be added or replaced.
|
|
<dl class="parml">
|
|
<dt class="bold"><var class="pv">string-constant</var></dt>
|
|
<dd>Can be any character-string constant of up to 2000 characters (500 for
|
|
a sequence).<a id="idx1549" name="idx1549"></a>
|
|
</dd>
|
|
</dl>
|
|
</dd>
|
|
</dl>
|
|
<a name="wq1152"></a>
|
|
<h4 id="wq1152">multiple-column-list</h4>
|
|
<p>To comment on more than one column in a table or view, specify the table
|
|
or view name and then, in parenthesis, a list of the form: </p>
|
|
<pre class="xmp"> column-name <span class="bold">IS</span> string-constant,
|
|
column-name <span class="bold">IS</span> string-constant, ...</pre><p class="indatacontent"> The column
|
|
name must not be qualified, each name must identify a column of the specified
|
|
table or view, and that table or view must exist at the current server.</p>
|
|
<a name="wq1153"></a>
|
|
<h4 id="wq1153">multiple-parameter-list</h4>
|
|
<p>To comment on more than one parameter in a procedure or function, specify
|
|
the procedure name, function name, or specific name, and then, in parenthesis,
|
|
a list of the form: </p>
|
|
<pre class="xmp"> parameter-name <span class="bold">IS</span> string-constant,
|
|
parameter-name <span class="bold">IS</span> string-constant, ...</pre><p class="indatacontent"> The
|
|
parameter name must not be qualified, each name must identify a parameter
|
|
of the specified procedure or function, and that procedure or function must
|
|
exist at the current server.</p>
|
|
<a name="wq1154"></a>
|
|
<h3 id="wq1154"><a href="rbafzmst02.htm#ToC_814">Notes</a></h3>
|
|
<p><span class="bold">Syntax alternatives:</span> The following keywords are synonyms
|
|
supported for compatibility to prior releases. These keywords are non-standard
|
|
and should not be used:</p>
|
|
<ul>
|
|
<li>The keyword PROGRAM can be used as a synonym for PACKAGE.</li>
|
|
<li>The keyword DATA can be used as a synonym for DISTINCT.</li></ul>
|
|
<a name="wq1155"></a>
|
|
<h3 id="wq1155"><a href="rbafzmst02.htm#ToC_815">Examples</a></h3>
|
|
<p><span class="italic">Example 1:</span> Insert a comment for the EMPLOYEE table. </p>
|
|
<pre class="xmp"> <span class="bold">COMMENT ON TABLE</span> EMPLOYEE
|
|
<span class="bold">IS</span> 'Reflects first quarter 2000 reorganization'</pre>
|
|
<p><span class="italic">Example 2:</span> Insert a comment for the EMP_VIEW1
|
|
view. </p>
|
|
<pre class="xmp"> <span class="bold">COMMENT ON TABLE</span> EMP_VIEW1
|
|
<span class="bold">IS</span> 'View of the EMPLOYEE table without salary information'</pre>
|
|
<p><span class="italic">Example 3:</span> Insert a comment for the EDLEVEL column
|
|
of the EMPLOYEE table. </p>
|
|
<pre class="xmp"> <span class="bold">COMMENT ON COLUMN</span> EMPLOYEE.EDLEVEL
|
|
<span class="bold">IS</span> 'Highest grade level passed in school'</pre>
|
|
<p><span class="italic">Example 4:</span> Enter comments on two columns in the
|
|
DEPARTMENT table. </p>
|
|
<a name="r2cme4"></a>
|
|
<pre id="r2cme4" class="xmp"> <span class="bold">COMMENT ON</span> DEPARTMENT
|
|
<span class="bold">(</span>MGRNO <span class="bold">IS</span> 'EMPLOYEE NUMBER OF DEPARTMENT MANAGER',
|
|
ADMRDEPT <span class="bold">IS</span> 'DEPARTMENT NUMBER OF ADMINISTERING DEPARTMENT'<span class="bold">)</span></pre>
|
|
<p><span class="italic">Example 5:</span> Insert a comment for the PAYROLL package. </p>
|
|
<pre class="xmp"> <span class="bold">COMMENT ON PACKAGE</span> PAYROLL
|
|
<span class="bold">IS</span> 'This package is used for distributed payroll processing.'</pre>
|
|
<p><a id="idx1550" name="idx1550"></a><a id="idx1551" name="idx1551"></a></p>
|
|
<hr /><div class="fnnum"><a id="wq1151" name="wq1151" href="rbafzmstcomnt.htm#wq1150">60</a>.</div>
|
|
<div class="fntext">If the identified package has a <var class="pv">version-id</var>, the comment is limited
|
|
to 176 bytes.</div>
|
|
<br />
|
|
<hr /><br />
|
|
[ <a href="#Top_Of_Page">Top of Page</a> | <a href="rbafzmstclosst.htm">Previous Page</a> | <a href="rbafzmstc4comit.htm">Next Page</a> | <a href="rbafzmst02.htm#wq1">Contents</a> |
|
|
<a href="rbafzmstindex.htm#index">Index</a> ]
|
|
|
|
<a id="Bot_Of_Page" name="Bot_Of_Page"></a>
|
|
</body>
|
|
</html>
|