📄 function.db2-procedure-columns.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><html> <head> <title>Returns a result set listing stored procedure parameters</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> </head> <body><div style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.db2-primary-keys.html">db2_primary_keys</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.db2-procedures.html">db2_procedures</a></div> <div class="up"><a href="ref.ibm-db2.html">IBM DB2 Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div></div><hr /><div id="function.db2-procedure-columns" class="refentry"> <div class="refnamediv"> <h1 class="refname">db2_procedure_columns</h1> <p class="verinfo">(PECL ibm_db2:1.0-1.6.2)</p><p class="refpurpose"><span class="refname">db2_procedure_columns</span> — <span class="dc-title"> Returns a result set listing stored procedure parameters </span></p> </div> <div class="refsect1 description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">resource</span> <span class="methodname"><b><b>db2_procedure_columns</b></b></span> ( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$connection</tt></span> , <span class="methodparam"><span class="type">string</span> <tt class="parameter">$qualifier</tt></span> , <span class="methodparam"><span class="type">string</span> <tt class="parameter">$schema</tt></span> , <span class="methodparam"><span class="type">string</span> <tt class="parameter">$procedure</tt></span> , <span class="methodparam"><span class="type">string</span> <tt class="parameter">$parameter</tt></span> )</div> <p class="para rdfs-comment"> Returns a result set listing the parameters for one or more stored procedures. </p> </div> <div class="refsect1 parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><i><tt class="parameter">connection</tt></i></span> <dd> <p class="para"> A valid connection to an IBM DB2, Cloudscape, or Apache Derby database. </p> </dd> </dt> <dt> <span class="term"><i><tt class="parameter">qualifier</tt></i></span> <dd> <p class="para"> A qualifier for DB2 databases running on OS/390 or z/OS servers. For other databases, pass <b><tt>NULL</tt></b> or an empty string. </p> </dd> </dt> <dt> <span class="term"><i><tt class="parameter">schema</tt></i></span> <dd> <p class="para"> The schema which contains the procedures. This parameter accepts a search pattern containing <i>_</i> and <i>%</i> as wildcards. </p> </dd> </dt> <dt> <span class="term"><i><tt class="parameter">procedure</tt></i></span> <dd> <p class="para"> The name of the procedure. This parameter accepts a search pattern containing <i>_</i> and <i>%</i> as wildcards. </p> </dd> </dt> <dt> <span class="term"><i><tt class="parameter">parameter</tt></i></span> <dd> <p class="para"> The name of the parameter. This parameter accepts a search pattern containing <i>_</i> and <i>%</i> as wildcards. If this parameter is <b><tt>NULL</tt></b>, all parameters for the specified stored procedures are returned. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns a statement resource with a result set containing rows describing the parameters for the stored procedures matching the specified parameters. The rows are composed of the following columns: <table class="informaltable"> <colgroup> <thead valign="middle"> <tr valign="middle"> <th colspan="1">Column name</th> <th colspan="1">Description</th> </tr> </thead> <tbody valign="middle" class="tbody"> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">PROCEDURE_CAT</td> <td colspan="1" rowspan="1" align="left">The catalog that contains the procedure. The value is <b><tt>NULL</tt></b> if this table does not have catalogs.</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">PROCEDURE_SCHEM</td> <td colspan="1" rowspan="1" align="left">Name of the schema that contains the stored procedure.</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">PROCEDURE_NAME</td> <td colspan="1" rowspan="1" align="left">Name of the procedure.</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">COLUMN_NAME</td> <td colspan="1" rowspan="1" align="left">Name of the parameter.</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">COLUMN_TYPE</td> <td colspan="1" rowspan="1" align="left"> <p class="para"> An integer value representing the type of the parameter: <table class="informaltable"> <colgroup> <thead valign="middle"> <tr valign="middle"> <th colspan="1">Return value</th> <th colspan="1">Parameter type</th> </tr> </thead> <tbody valign="middle" class="tbody"> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">1 (SQL_PARAM_INPUT)</td> <td colspan="1" rowspan="1" align="left">Input (IN) parameter.</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">2 (SQL_PARAM_INPUT_OUTPUT)</td> <td colspan="1" rowspan="1" align="left">Input/output (INOUT) parameter.</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">3 (SQL_PARAM_OUTPUT)</td> <td colspan="1" rowspan="1" align="left">Output (OUT) parameter.</td> </tr> </tbody> </colgroup> </table> </p> </td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">DATA_TYPE</td> <td colspan="1" rowspan="1" align="left">The SQL data type for the parameter represented as an integer value.</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">TYPE_NAME</td> <td colspan="1" rowspan="1" align="left">A string representing the data type for the parameter.</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">COLUMN_SIZE</td> <td colspan="1" rowspan="1" align="left">An integer value representing the size of the parameter.</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">BUFFER_LENGTH</td> <td colspan="1" rowspan="1" align="left"> Maximum number of bytes necessary to store data for this parameter. </td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">DECIMAL_DIGITS</td> <td colspan="1" rowspan="1" align="left"> The scale of the parameter, or <b><tt>NULL</tt></b> where scale is not applicable. </td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">NUM_PREC_RADIX</td> <td colspan="1" rowspan="1" align="left"> An integer value of either <i>10</i> (representing an exact numeric data type), <i>2</i> (representing an approximate numeric data type), or <b><tt>NULL</tt></b> (representing a data type for which radix is not applicable). </td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">NULLABLE</td> <td colspan="1" rowspan="1" align="left">An integer value representing whether the parameter is nullable or not.</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">REMARKS</td> <td colspan="1" rowspan="1" align="left">Description of the parameter.</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">COLUMN_DEF</td> <td colspan="1" rowspan="1" align="left">Default value for the parameter.</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">SQL_DATA_TYPE</td> <td colspan="1" rowspan="1" align="left">An integer value representing the size of the parameter.</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">SQL_DATETIME_SUB</td> <td colspan="1" rowspan="1" align="left"> Returns an integer value representing a datetime subtype code, or <b><tt>NULL</tt></b> for SQL data types to which this does not apply. </td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">CHAR_OCTET_LENGTH</td> <td colspan="1" rowspan="1" align="left"> Maximum length in octets for a character data type parameter, which matches COLUMN_SIZE for single-byte character set data, or <b><tt>NULL</tt></b> for non-character data types. </td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">ORDINAL_POSITION</td> <td colspan="1" rowspan="1" align="left">The 1-indexed position of the parameter in the CALL statement.</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">IS_NULLABLE</td> <td colspan="1" rowspan="1" align="left"> A string value where 'YES' means that the parameter accepts or returns <b><tt>NULL</tt></b> values and 'NO' means that the parameter does not accept or return <b><tt>NULL</tt></b> values. </td> </tr> </tbody> </colgroup> </table> </p> </div> <div class="refsect1 seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"><a href="function.db2-column-privileges.html" class="function" rel="rdfs-seeAlso">db2_column_privileges()</a></li> <li class="member"><a href="function.db2-columns.html" class="function" rel="rdfs-seeAlso">db2_columns()</a></li> <li class="member"><a href="function.db2-foreign-keys.html" class="function" rel="rdfs-seeAlso">db2_foreign_keys()</a></li> <li class="member"><a href="function.db2-primary-keys.html" class="function" rel="rdfs-seeAlso">db2_primary_keys()</a></li> <li class="member"><a href="function.db2-procedures.html" class="function" rel="rdfs-seeAlso">db2_procedures()</a></li> <li class="member"><a href="function.db2-special-columns.html" class="function" rel="rdfs-seeAlso">db2_special_columns()</a></li> <li class="member"><a href="function.db2-statistics.html" class="function" rel="rdfs-seeAlso">db2_statistics()</a></li> <li class="member"><a href="function.db2-table-privileges.html" class="function" rel="rdfs-seeAlso">db2_table_privileges()</a></li> <li class="member"><a href="function.db2-tables.html" class="function" rel="rdfs-seeAlso">db2_tables()</a></li> </ul> </p> </div></div><hr /><div style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.db2-primary-keys.html">db2_primary_keys</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.db2-procedures.html">db2_procedures</a></div> <div class="up"><a href="ref.ibm-db2.html">IBM DB2 Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div></div></body></html>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -