cvs: phpdoc /en/reference/ibm_db2/functions db2-procedure-columns.xml db2-procedures.xml
| From: | Dan Scott | Date: | Fri, 29 Apr 2005 16:23:17 +0000 |
| Subject: | cvs: phpdoc /en/reference/ibm_db2/functions db2-procedure-columns.xml db2-procedures.xml | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969368113@lists.php.net to get a copy of this message | ||
dbs Fri Apr 29 12:23:17 2005 EDT
Modified files:
/phpdoc/en/reference/ibm_db2/functions db2-procedure-columns.xml
db2-procedures.xml
Log:
Document the procedure metadata functions.
http://cvs.php.net/diff.php/phpdoc/en/reference/ibm_db2/functions/db2-procedure-columns.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/ibm_db2/functions/db2-procedure-columns.xml diff -u phpdoc/en/reference/ibm_db2/functions/db2-procedure-columns.xml:1.1 phpdoc/en/reference/ibm_db2/functions/db2-procedure-columns.xml:1.2 --- phpdoc/en/reference/ibm_db2/functions/db2-procedure-columns.xml:1.1 Tue Apr 12 17:12:48 2005 +++ phpdoc/en/reference/ibm_db2/functions/db2-procedure-columns.xml Fri Apr 29 12:23:16 2005 @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.db2-procedure-columns"> <refnamediv> <refname>db2_procedure_columns</refname> <refpurpose> - Returns a result set listing the input and output parameters for a stored procedure + Returns a result set listing stored procedure parameters </refpurpose> </refnamediv> <refsect1 role="description"> @@ -14,12 +14,16 @@ <type>resource</type><methodname>db2_procedure_columns</methodname> <methodparam><type>resource</type><parameter>connection</parameter></methodparam> <methodparam><type>string</type><parameter>qualifier</parameter></methodparam> - <methodparam><type>string</type><parameter>owner</parameter></methodparam> - <methodparam><type>string</type><parameter>table_name</parameter></methodparam> - <methodparam><type>string</type><parameter>column_name</parameter></methodparam> + <methodparam><type>string</type><parameter>schema</parameter></methodparam> + <methodparam><type>string</type><parameter>procedure</parameter></methodparam> + <methodparam><type>string</type><parameter>column</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + &warn.experimental.func; + <para> + Returns a result set listing the parameters for one or more stored + procedures. + </para> </refsect1> <refsect1 role="parameters"> @@ -28,89 +32,200 @@ <variablelist> <varlistentry> <term><parameter>connection</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> - </varlistentry> + <listitem> + <para> + A valid connection to an IBM DB2, Cloudscape, or Apache Derby database. + </para> + </listitem> + </varlistentry> <varlistentry> <term><parameter>qualifier</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> - </varlistentry> + <listitem> + <para> + The schema which contains the procedures. To match all schemas, pass + &null; or an empty string. + </para> + </listitem> + </varlistentry> <varlistentry> - <term><parameter>owner</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> - </varlistentry> + <term><parameter>schema</parameter></term> + <listitem> + <para> + The schema which contains the procedures. To match all schemas, pass + &null; or an empty string. + </para> + </listitem> + </varlistentry> <varlistentry> - <term><parameter>table_name</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> + <term><parameter>procedure</parameter></term> + <listitem> + <para> + The name of the procedure. To match all procedures in the schema, pass + &null; or an empty string. + </para> + </listitem> </varlistentry> <varlistentry> - <term><parameter>column_name</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> - </varlistentry> + <term><parameter>parameter</parameter></term> + <listitem> + <para> + The name of the parameter. To match all parameters in the stored + procedure, pass &null; or an empty string. + </para> + </listitem> + </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - What the function returns, first on success, then on failure. See - also the &return.success; entity - </para> - </refsect1> - - <!-- Use when EXCEPTIONS exist - <refsect1 role="exceptions"> - &reftitle.exceptions; - <para> - When does this function throw exceptions? - </para> - </refsect1> - --> - - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <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: <informaltable> <tgroup cols="2"> <thead> <row> - <entry>&Version;</entry> - <entry>&Description</entry> + <entry>Column name</entry> + <entry>Description</entry> </row> </thead> <tbody> - <row> - <entry>Enter the PHP version of change here - <entry>Description of change - </row> + <row> + <entry>PROCEDURE_CAT</entry> + <entry>The catalog that contains the procedure. The value is &null; if + this table does not have catalogs.</entry> + </row> + <row> + <entry>PROCEDURE_SCHEM</entry> + <entry>Name of the schema that contains the stored procedure.</entry> + </row> + <row> + <entry>PROCEDURE_NAME</entry> + <entry>Name of the procedure.</entry> + </row> + <row> + <entry>COLUMN_NAME</entry> + <entry>Name of the parameter.</entry> + </row> + <row> + <entry>COLUMN_TYPE</entry> + <entry> + <para> + An integer value representing the type of the parameter: + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>Return value</entry> + <entry>Parameter type</entry> + </row> + </thead> + <tbody> + <row> + <entry>1 (SQL_PARAM_INPUT)</entry> + <entry>Input (IN) parameter.</entry> + </row> + <row> + <entry>2 (SQL_PARAM_INPUT_OUTPUT)</entry> + <entry>Input/output (INOUT) parameter.</entry> + </row> + <row> + <entry>3 (SQL_PARAM_OUTPUT)</entry> + <entry>Output (OUT) parameter.</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </entry> + </row> + <row> + <entry>DATA_TYPE</entry> + <entry>The SQL data type for the parameter represented as an integer + value.</entry> + </row> + <row> + <entry>TYPE_NAME</entry> + <entry>A string representing the data type for the parameter.</entry> + </row> + <row> + <entry>COLUMN_SIZE</entry> + <entry>An integer value representing the size of the parameter.</entry> + </row> + <row> + <entry>BUFFER_LENGTH</entry> + <entry> + Maximum number of bytes necessary to store data for this parameter. + </entry> + </row> + <row> + <entry>DECIMAL_DIGITS</entry> + <entry> + The scale of the parameter, or &null; where scale is not applicable. + </entry> + </row> + <row> + <entry>NUM_PREC_RADIX</entry> + <entry> + An integer value of either <literal>10</literal> (representing + an exact numeric data type), <literal>2</literal> (representing an + approximate numeric data type), or &null; (representing a data type for + which radix is not applicable). + </entry> + </row> + <row> + <entry>NULLABLE</entry> + <entry>An integer value representing whether the parameter is nullable + or not.</entry> + </row> + <row> + <entry>REMARKS</entry> + <entry>Description of the parameter.</entry> + </row> + <row> + <entry>COLUMN_DEF</entry> + <entry>Default value for the parameter.</entry> + </row> + <row> + <entry>SQL_DATA_TYPE</entry> + <entry>An integer value representing the size of the parameter.</entry> + </row> + <row> + <entry>SQL_DATETIME_SUB</entry> + <entry> + Returns an integer value representing a datetime subtype code, + or &null; for SQL data types to which this does not apply. + </entry> + </row> + <row> + <entry>CHAR_OCTET_LENGTH</entry> + <entry> + Maximum length in octets for a character data type parameter, which + matches COLUMN_SIZE for single-byte character set data, or &null; for + non-character data types. + </entry> + </row> + <row> + <entry>ORDINAL_POSITION</entry> + <entry>The 1-indexed position of the parameter in the CALL + statement.</entry> + </row> + <row> + <entry>IS_NULLABLE</entry> + <entry> + A string value where 'YES' means that the parameter accepts or + returns &null; values and 'NO' means that the parameter does not + accept or return &null; values. + </entry> + </row> </tbody> </tgroup> </informaltable> + </para> </refsect1> - --> - <!-- Use when examples exist <refsect1 role="examples"> @@ -143,18 +258,22 @@ </refsect1> --> - - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><function>db2_column_privileges</function></member> + <member><function>db2_columns</function></member> + <member><function>db2_foreign_keys</function></member> + <member><function>db2_primary_keys</function></member> + <member><function>db2_procedures</function></member> + <member><function>db2_special_columns</function></member> + <member><function>db2_statistics</function></member> + <member><function>db2_table_privileges</function></member> + <member><function>db2_tables</function></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/ibm_db2/functions/db2-procedures.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/ibm_db2/functions/db2-procedures.xml diff -u phpdoc/en/reference/ibm_db2/functions/db2-procedures.xml:1.1 phpdoc/en/reference/ibm_db2/functions/db2-procedures.xml:1.2 --- phpdoc/en/reference/ibm_db2/functions/db2-procedures.xml:1.1 Tue Apr 12 17:12:48 2005 +++ phpdoc/en/reference/ibm_db2/functions/db2-procedures.xml Fri Apr 29 12:23:16 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.db2-procedures"> <refnamediv> @@ -14,12 +14,16 @@ <type>resource</type><methodname>db2_procedures</methodname> <methodparam><type>resource</type><parameter>connection</parameter></methodparam> <methodparam><type>string</type><parameter>qualifier</parameter></methodparam> - <methodparam><type>string</type><parameter>owner</parameter></methodparam> - <methodparam><type>string</type><parameter>table_name</parameter></methodparam> - <methodparam><type>string</type><parameter>column_name</parameter></methodparam> + <methodparam><type>string</type><parameter>schema</parameter></methodparam> + <methodparam><type>string</type><parameter>procedure</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + &warn.experimental.func; + + <para> + Returns a result set listing the stored procedures registered in a + database. + </para> </refsect1> <refsect1 role="parameters"> @@ -28,89 +32,97 @@ <variablelist> <varlistentry> <term><parameter>connection</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> - </varlistentry> + <listitem> + <para> + A valid connection to an IBM DB2, Cloudscape, or Apache Derby database. + </para> + </listitem> + </varlistentry> <varlistentry> <term><parameter>qualifier</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> - </varlistentry> + <listitem> + <para> + A qualifier for DB2 databases running on OS/390 or z/OS servers. For + other databases, pass &null; or an empty string. + </para> + </listitem> + </varlistentry> <varlistentry> - <term><parameter>owner</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> - </varlistentry> + <term><parameter>schema</parameter></term> + <listitem> + <para> + The schema which contains the procedures. To match all schemas, pass + &null; or an empty string. + </para> + </listitem> + </varlistentry> <varlistentry> - <term><parameter>table_name</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>column_name</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> - </varlistentry> - </variablelist> + <term><parameter>procedure</parameter></term> + <listitem> + <para> + The name of the procedure. To match all procedures in the schema, pass + &null; or an empty string. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - What the function returns, first on success, then on failure. See - also the &return.success; entity - </para> - </refsect1> - - <!-- Use when EXCEPTIONS exist - <refsect1 role="exceptions"> - &reftitle.exceptions; - <para> - When does this function throw exceptions? - </para> - </refsect1> - --> - - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> + Returns a statement resource with a result set containing rows describing + the stored procedures matching the specified parameters. The rows are + composed of the following columns: <informaltable> <tgroup cols="2"> <thead> <row> - <entry>&Version;</entry> - <entry>&Description</entry> + <entry>Column name</entry> + <entry>Description</entry> </row> </thead> <tbody> - <row> - <entry>Enter the PHP version of change here - <entry>Description of change - </row> + <row> + <entry>PROCEDURE_CAT</entry> + <entry>The catalog that contains the procedure. The value is &null; if + this table does not have catalogs.</entry> + </row> + <row> + <entry>PROCEDURE_SCHEM</entry> + <entry>Name of the schema that contains the stored procedure.</entry> + </row> + <row> + <entry>PROCEDURE_NAME</entry> + <entry>Name of the procedure.</entry> + </row> + <row> + <entry>NUM_INPUT_PARAMS</entry> + <entry>Number of input (IN) parameters for the stored procedure.</entry> + </row> + <row> + <entry>NUM_OUTPUT_PARAMS</entry> + <entry>Number of output (OUT) parameters for the stored procedure.</entry> + </row> + <row> + <entry>NUM_RESULT_SETS</entry> + <entry>Number of result sets returned by the stored procedure.</entry> + </row> + <row> + <entry>REMARKS</entry> + <entry>Any comments about the stored procedure.</entry> + </row> + <row> + <entry>PROCEDURE_TYPE</entry> + <entry>Always returns <literal>1</literal>, indicating that the stored + procedure does not return a return value.</entry> + </row> </tbody> </tgroup> </informaltable> + </para> </refsect1> - --> - <!-- Use when examples exist <refsect1 role="examples"> @@ -143,18 +155,22 @@ </refsect1> --> - - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><function>db2_column_privileges</function></member> + <member><function>db2_columns</function></member> + <member><function>db2_foreign_keys</function></member> + <member><function>db2_primary_keys</function></member> + <member><function>db2_procedure_columns</function></member> + <member><function>db2_special_columns</function></member> + <member><function>db2_statistics</function></member> + <member><function>db2_table_privileges</function></member> + <member><function>db2_tables</function></member> </simplelist> </para> </refsect1> - --> </refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/ibm_db2/functions/db2-procedure-columns.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/ibm_db2/functions/db2-procedure-columns.xml diff -u phpdoc/en/reference/ibm_db2/functions/db2-procedure-columns.xml:1.1 phpdoc/en/reference/ibm_db2/functions/db2-procedure-columns.xml:1.2 --- phpdoc/en/reference/ibm_db2/functions/db2-procedure-columns.xml:1.1 Tue Apr 12 17:12:48 2005 +++ phpdoc/en/reference/ibm_db2/functions/db2-procedure-columns.xml Fri Apr 29 12:23:16 2005 @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.db2-procedure-columns"> <refnamediv> <refname>db2_procedure_columns</refname> <refpurpose> - Returns a result set listing the input and output parameters for a stored procedure + Returns a result set listing stored procedure parameters </refpurpose> </refnamediv> <refsect1 role="description"> @@ -14,12 +14,16 @@ <type>resource</type><methodname>db2_procedure_columns</methodname> <methodparam><type>resource</type><parameter>connection</parameter></methodparam> <methodparam><type>string</type><parameter>qualifier</parameter></methodparam> - <methodparam><type>string</type><parameter>owner</parameter></methodparam> - <methodparam><type>string</type><parameter>table_name</parameter></methodparam> - <methodparam><type>string</type><parameter>column_name</parameter></methodparam> + <methodparam><type>string</type><parameter>schema</parameter></methodparam> + <methodparam><type>string</type><parameter>procedure</parameter></methodparam> + <methodparam><type>string</type><parameter>column</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + &warn.experimental.func; + <para> + Returns a result set listing the parameters for one or more stored + procedures. + </para> </refsect1> <refsect1 role="parameters"> @@ -28,89 +32,200 @@ <variablelist> <varlistentry> <term><parameter>connection</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> - </varlistentry> + <listitem> + <para> + A valid connection to an IBM DB2, Cloudscape, or Apache Derby database. + </para> + </listitem> + </varlistentry> <varlistentry> <term><parameter>qualifier</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> - </varlistentry> + <listitem> + <para> + The schema which contains the procedures. To match all schemas, pass + &null; or an empty string. + </para> + </listitem> + </varlistentry> <varlistentry> - <term><parameter>owner</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> - </varlistentry> + <term><parameter>schema</parameter></term> + <listitem> + <para> + The schema which contains the procedures. To match all schemas, pass + &null; or an empty string. + </para> + </listitem> + </varlistentry> <varlistentry> - <term><parameter>table_name</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> + <term><parameter>procedure</parameter></term> + <listitem> + <para> + The name of the procedure. To match all procedures in the schema, pass + &null; or an empty string. + </para> + </listitem> </varlistentry> <varlistentry> - <term><parameter>column_name</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> - </varlistentry> + <term><parameter>parameter</parameter></term> + <listitem> + <para> + The name of the parameter. To match all parameters in the stored + procedure, pass &null; or an empty string. + </para> + </listitem> + </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - What the function returns, first on success, then on failure. See - also the &return.success; entity - </para> - </refsect1> - - <!-- Use when EXCEPTIONS exist - <refsect1 role="exceptions"> - &reftitle.exceptions; - <para> - When does this function throw exceptions? - </para> - </refsect1> - --> - - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <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: <informaltable> <tgroup cols="2"> <thead> <row> - <entry>&Version;</entry> - <entry>&Description</entry> + <entry>Column name</entry> + <entry>Description</entry> </row> </thead> <tbody> - <row> - <entry>Enter the PHP version of change here - <entry>Description of change - </row> + <row> + <entry>PROCEDURE_CAT</entry> + <entry>The catalog that contains the procedure. The value is &null; if + this table does not have catalogs.</entry> + </row> + <row> + <entry>PROCEDURE_SCHEM</entry> + <entry>Name of the schema that contains the stored procedure.</entry> + </row> + <row> + <entry>PROCEDURE_NAME</entry> + <entry>Name of the procedure.</entry> + </row> + <row> + <entry>COLUMN_NAME</entry> + <entry>Name of the parameter.</entry> + </row> + <row> + <entry>COLUMN_TYPE</entry> + <entry> + <para> + An integer value representing the type of the parameter: + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>Return value</entry> + <entry>Parameter type</entry> + </row> + </thead> + <tbody> + <row> + <entry>1 (SQL_PARAM_INPUT)</entry> + <entry>Input (IN) parameter.</entry> + </row> + <row> + <entry>2 (SQL_PARAM_INPUT_OUTPUT)</entry> + <entry>Input/output (INOUT) parameter.</entry> + </row> + <row> + <entry>3 (SQL_PARAM_OUTPUT)</entry> + <entry>Output (OUT) parameter.</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </entry> + </row> + <row> + <entry>DATA_TYPE</entry> + <entry>The SQL data type for the parameter represented as an integer + value.</entry> + </row> + <row> + <entry>TYPE_NAME</entry> + <entry>A string representing the data type for the parameter.</entry> + </row> + <row> + <entry>COLUMN_SIZE</entry> + <entry>An integer value representing the size of the parameter.</entry> + </row> + <row> + <entry>BUFFER_LENGTH</entry> + <entry> + Maximum number of bytes necessary to store data for this parameter. + </entry> + </row> + <row> + <entry>DECIMAL_DIGITS</entry> + <entry> + The scale of the parameter, or &null; where scale is not applicable. + </entry> + </row> + <row> + <entry>NUM_PREC_RADIX</entry> + <entry> + An integer value of either <literal>10</literal> (representing + an exact numeric data type), <literal>2</literal> (representing an + approximate numeric data type), or &null; (representing a data type for + which radix is not applicable). + </entry> + </row> + <row> + <entry>NULLABLE</entry> + <entry>An integer value representing whether the parameter is nullable + or not.</entry> + </row> + <row> + <entry>REMARKS</entry> + <entry>Description of the parameter.</entry> + </row> + <row> + <entry>COLUMN_DEF</entry> + <entry>Default value for the parameter.</entry> + </row> + <row> + <entry>SQL_DATA_TYPE</entry> + <entry>An integer value representing the size of the parameter.</entry> + </row> + <row> + <entry>SQL_DATETIME_SUB</entry> + <entry> + Returns an integer value representing a datetime subtype code, + or &null; for SQL data types to which this does not apply. + </entry> + </row> + <row> + <entry>CHAR_OCTET_LENGTH</entry> + <entry> + Maximum length in octets for a character data type parameter, which + matches COLUMN_SIZE for single-byte character set data, or &null; for + non-character data types. + </entry> + </row> + <row> + <entry>ORDINAL_POSITION</entry> + <entry>The 1-indexed position of the parameter in the CALL + statement.</entry> + </row> + <row> + <entry>IS_NULLABLE</entry> + <entry> + A string value where 'YES' means that the parameter accepts or + returns &null; values and 'NO' means that the parameter does not + accept or return &null; values. + </entry> + </row> </tbody> </tgroup> </informaltable> + </para> </refsect1> - --> - <!-- Use when examples exist <refsect1 role="examples"> @@ -143,18 +258,22 @@ </refsect1> --> - - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><function>db2_column_privileges</function></member> + <member><function>db2_columns</function></member> + <member><function>db2_foreign_keys</function></member> + <member><function>db2_primary_keys</function></member> + <member><function>db2_procedures</function></member> + <member><function>db2_special_columns</function></member> + <member><function>db2_statistics</function></member> + <member><function>db2_table_privileges</function></member> + <member><function>db2_tables</function></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/ibm_db2/functions/db2-procedures.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/ibm_db2/functions/db2-procedures.xml diff -u phpdoc/en/reference/ibm_db2/functions/db2-procedures.xml:1.1 phpdoc/en/reference/ibm_db2/functions/db2-procedures.xml:1.2 --- phpdoc/en/reference/ibm_db2/functions/db2-procedures.xml:1.1 Tue Apr 12 17:12:48 2005 +++ phpdoc/en/reference/ibm_db2/functions/db2-procedures.xml Fri Apr 29 12:23:16 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.db2-procedures"> <refnamediv> @@ -14,12 +14,16 @@ <type>resource</type><methodname>db2_procedures</methodname> <methodparam><type>resource</type><parameter>connection</parameter></methodparam> <methodparam><type>string</type><parameter>qualifier</parameter></methodparam> - <methodparam><type>string</type><parameter>owner</parameter></methodparam> - <methodparam><type>string</type><parameter>table_name</parameter></methodparam> - <methodparam><type>string</type><parameter>column_name</parameter></methodparam> + <methodparam><type>string</type><parameter>schema</parameter></methodparam> + <methodparam><type>string</type><parameter>procedure</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + &warn.experimental.func; + + <para> + Returns a result set listing the stored procedures registered in a + database. + </para> </refsect1> <refsect1 role="parameters"> @@ -28,89 +32,97 @@ <variablelist> <varlistentry> <term><parameter>connection</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> - </varlistentry> + <listitem> + <para> + A valid connection to an IBM DB2, Cloudscape, or Apache Derby database. + </para> + </listitem> + </varlistentry> <varlistentry> <term><parameter>qualifier</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> - </varlistentry> + <listitem> + <para> + A qualifier for DB2 databases running on OS/390 or z/OS servers. For + other databases, pass &null; or an empty string. + </para> + </listitem> + </varlistentry> <varlistentry> - <term><parameter>owner</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> - </varlistentry> + <term><parameter>schema</parameter></term> + <listitem> + <para> + The schema which contains the procedures. To match all schemas, pass + &null; or an empty string. + </para> + </listitem> + </varlistentry> <varlistentry> - <term><parameter>table_name</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>column_name</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> - </varlistentry> - </variablelist> + <term><parameter>procedure</parameter></term> + <listitem> + <para> + The name of the procedure. To match all procedures in the schema, pass + &null; or an empty string. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - What the function returns, first on success, then on failure. See - also the &return.success; entity - </para> - </refsect1> - - <!-- Use when EXCEPTIONS exist - <refsect1 role="exceptions"> - &reftitle.exceptions; - <para> - When does this function throw exceptions? - </para> - </refsect1> - --> - - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> + Returns a statement resource with a result set containing rows describing + the stored procedures matching the specified parameters. The rows are + composed of the following columns: <informaltable> <tgroup cols="2"> <thead> <row> - <entry>&Version;</entry> - <entry>&Description</entry> + <entry>Column name</entry> + <entry>Description</entry> </row> </thead> <tbody> - <row> - <entry>Enter the PHP version of change here - <entry>Description of change - </row> + <row> + <entry>PROCEDURE_CAT</entry> + <entry>The catalog that contains the procedure. The value is &null; if + this table does not have catalogs.</entry> + </row> + <row> + <entry>PROCEDURE_SCHEM</entry> + <entry>Name of the schema that contains the stored procedure.</entry> + </row> + <row> + <entry>PROCEDURE_NAME</entry> + <entry>Name of the procedure.</entry> + </row> + <row> + <entry>NUM_INPUT_PARAMS</entry> + <entry>Number of input (IN) parameters for the stored procedure.</entry> + </row> + <row> + <entry>NUM_OUTPUT_PARAMS</entry> + <entry>Number of output (OUT) parameters for the stored procedure.</entry> + </row> + <row> + <entry>NUM_RESULT_SETS</entry> + <entry>Number of result sets returned by the stored procedure.</entry> + </row> + <row> + <entry>REMARKS</entry> + <entry>Any comments about the stored procedure.</entry> + </row> + <row> + <entry>PROCEDURE_TYPE</entry> + <entry>Always returns <literal>1</literal>, indicating that the stored + procedure does not return a return value.</entry> + </row> </tbody> </tgroup> </informaltable> + </para> </refsect1> - --> - <!-- Use when examples exist <refsect1 role="examples"> @@ -143,18 +155,22 @@ </refsect1> --> - - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><function>db2_column_privileges</function></member> + <member><function>db2_columns</function></member> + <member><function>db2_foreign_keys</function></member> + <member><function>db2_primary_keys</function></member> + <member><function>db2_procedure_columns</function></member> + <member><function>db2_special_columns</function></member> + <member><function>db2_statistics</function></member> + <member><function>db2_table_privileges</function></member> + <member><function>db2_tables</function></member> </simplelist> </para> </refsect1> - --> </refentry>