cvs: phpdoc /en/reference/ibm_db2/functions db2-statistics.xml
| From: | Dan Scott | Date: | Mon, 09 May 2005 15:14:19 +0000 |
| Subject: | cvs: phpdoc /en/reference/ibm_db2/functions db2-statistics.xml | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969368220@lists.php.net to get a copy of this message | ||
dbs Mon May 9 11:14:19 2005 EDT
Modified files:
/phpdoc/en/reference/ibm_db2/functions db2-statistics.xml
Log:
Document the final function of the ibm_db2 API (at least for now).
http://cvs.php.net/diff.php/phpdoc/en/reference/ibm_db2/functions/db2-statistics.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/ibm_db2/functions/db2-statistics.xml diff -u phpdoc/en/reference/ibm_db2/functions/db2-statistics.xml:1.2 phpdoc/en/reference/ibm_db2/functions/db2-statistics.xml:1.3 --- phpdoc/en/reference/ibm_db2/functions/db2-statistics.xml:1.2 Wed May 4 05:39:11 2005 +++ phpdoc/en/reference/ibm_db2/functions/db2-statistics.xml Mon May 9 11:14:18 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.db2-statistics"> <refnamediv> @@ -14,12 +14,15 @@ <type>resource</type><methodname>db2_statistics</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>schema</parameter></methodparam> + <methodparam><type>string</type><parameter>table-name</parameter></methodparam> <methodparam><type>bool</type><parameter>unique</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + &warn.experimental.func; + <para> + Returns a result set listing the index and statistics for a table. + </para> </refsect1> <refsect1 role="parameters"> @@ -28,43 +31,64 @@ <variablelist> <varlistentry> <term><parameter>connection</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> + <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> + <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> + <term><parameter>schema</parameter></term> + <listitem> + <para> + The schema that contains the targeted table. If this parameter is + &null;, the statistics and indexes are returned for the schema of the + current user. + </para> + </listitem> </varlistentry> <varlistentry> <term><parameter>table_name</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> + <listitem> + <para> + The name of the table. + </para> + </listitem> </varlistentry> <varlistentry> <term><parameter>unique</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> + <listitem> + <para> + An integer value representing the type of index information to return. + <variablelist> + <varlistentry> + <term><parameter>0</parameter></term> + <listitem> + <para> + Return only the information for unique indexes on the table. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>1</parameter></term> + <listitem> + <para> + Return the information for all indexes on the table. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </listitem> </varlistentry> </variablelist> </para> @@ -72,45 +96,169 @@ <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 statistics and indexes for the base tables 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 + <entry>TABLE_CAT</entry> + <entry>The catalog that contains the table. The value is &null; if + this table does not have catalogs.</entry> + </row> + <row> + <entry>TABLE_SCHEM</entry> + <entry>Name of the schema that contains the table.</entry> + </row> + <row> + <entry>TABLE_NAME</entry> + <entry>Name of the table.</entry> + </row> + <row> + <entry>NON_UNIQUE</entry> + <entry> + <para> + An integer value representing whether the index prohibits unique + values, or whether the row represents statistics on the table itself: + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>Return value</entry> + <entry>Parameter type</entry> + </row> + </thead> + <tbody> + <row> + <entry>0 (SQL_FALSE)</entry> + <entry>The index allows duplicate values.</entry> + </row> + <row> + <entry>1 (SQL_TRUE)</entry> + <entry>The index values must be unique.</entry> + </row> + <row> + <entry>&null;</entry> + <entry>This row is statistics information for the table itself.</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </entry> + </row> + <row> + <entry>INDEX_QUALIFIER</entry> + <entry>A string value representing the qualifier that would have to be + prepended to INDEX_NAME to fully qualify the index.</entry> + </row> + <row> + <entry>INDEX_NAME</entry> + <entry>A string representing the name of the index.</entry> + </row> + <row> + <entry>TYPE</entry> + <entry> + <para> + An integer value representing the type of information contained in + this row of the result set: + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>Return value</entry> + <entry>Parameter type</entry> + </row> + </thead> + <tbody> + <row> + <entry>0 (SQL_TABLE_STAT)</entry> + <entry>The row contains statistics about the table itself.</entry> + </row> + <row> + <entry>1 (SQL_INDEX_CLUSTERED)</entry> + <entry>The row contains information about a clustered index.</entry> + </row> + <row> + <entry>2 (SQL_INDEX_HASH)</entry> + <entry>The row contains information about a hashed index.</entry> + </row> + <row> + <entry>3 (SQL_INDEX_OTHER)</entry> + <entry>The row contains information about a type of index that + is neither clustered nor hashed.</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </entry> + </row> + <row> + <entry>ORDINAL_POSITION</entry> + <entry>The 1-indexed position of the column in the index. &null; if + the row contains statistics information about the table itself.</entry> + </row> + <row> + <entry>COLUMN_NAME</entry> + <entry>The name of the column in the index. &null; if the row + contains statistics information about the table itself.</entry> + </row> + <row> + <entry>ASC_OR_DESC</entry> + <entry> + <literal>A</literal> if the column is sorted in ascending order, + <literal>D</literal> if the column is sorted in descending order, + &null; if the row contains statistics information about the table + itself. + </entry> + </row> + <row> + <entry>CARDINALITY</entry> + <entry> + <para> + If the row contains information about an index, this column contains + an integer value representing the number of unique values in the + index. + </para> + <para> + If the row contains information about the table itself, this column + contains an integer value representing the number of rows in the + table. + </para> + </entry> + </row> + <row> + <entry>PAGES</entry> + <entry> + <para> + If the row contains information about an index, this column contains + an integer value representing the number of pages used to store the + index. + </para> + <para> + If the row contains information about the table itself, this column + contains an integer value representing the number of pages used to + store the table. + </para> + </entry> + </row> + <row> + <entry>FILTER_CONDITION</entry> + <entry>Always returns &null;.</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> - --> - <!-- Use when examples exist <refsect1 role="examples"> @@ -143,19 +291,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_procedures</function></member> + <member><function>db2_special_columns</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-statistics.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/ibm_db2/functions/db2-statistics.xml diff -u phpdoc/en/reference/ibm_db2/functions/db2-statistics.xml:1.2 phpdoc/en/reference/ibm_db2/functions/db2-statistics.xml:1.3 --- phpdoc/en/reference/ibm_db2/functions/db2-statistics.xml:1.2 Wed May 4 05:39:11 2005 +++ phpdoc/en/reference/ibm_db2/functions/db2-statistics.xml Mon May 9 11:14:18 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.db2-statistics"> <refnamediv> @@ -14,12 +14,15 @@ <type>resource</type><methodname>db2_statistics</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>schema</parameter></methodparam> + <methodparam><type>string</type><parameter>table-name</parameter></methodparam> <methodparam><type>bool</type><parameter>unique</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + &warn.experimental.func; + <para> + Returns a result set listing the index and statistics for a table. + </para> </refsect1> <refsect1 role="parameters"> @@ -28,43 +31,64 @@ <variablelist> <varlistentry> <term><parameter>connection</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> + <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> + <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> + <term><parameter>schema</parameter></term> + <listitem> + <para> + The schema that contains the targeted table. If this parameter is + &null;, the statistics and indexes are returned for the schema of the + current user. + </para> + </listitem> </varlistentry> <varlistentry> <term><parameter>table_name</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> + <listitem> + <para> + The name of the table. + </para> + </listitem> </varlistentry> <varlistentry> <term><parameter>unique</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> + <listitem> + <para> + An integer value representing the type of index information to return. + <variablelist> + <varlistentry> + <term><parameter>0</parameter></term> + <listitem> + <para> + Return only the information for unique indexes on the table. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>1</parameter></term> + <listitem> + <para> + Return the information for all indexes on the table. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </listitem> </varlistentry> </variablelist> </para> @@ -72,45 +96,169 @@ <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 statistics and indexes for the base tables 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 + <entry>TABLE_CAT</entry> + <entry>The catalog that contains the table. The value is &null; if + this table does not have catalogs.</entry> + </row> + <row> + <entry>TABLE_SCHEM</entry> + <entry>Name of the schema that contains the table.</entry> + </row> + <row> + <entry>TABLE_NAME</entry> + <entry>Name of the table.</entry> + </row> + <row> + <entry>NON_UNIQUE</entry> + <entry> + <para> + An integer value representing whether the index prohibits unique + values, or whether the row represents statistics on the table itself: + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>Return value</entry> + <entry>Parameter type</entry> + </row> + </thead> + <tbody> + <row> + <entry>0 (SQL_FALSE)</entry> + <entry>The index allows duplicate values.</entry> + </row> + <row> + <entry>1 (SQL_TRUE)</entry> + <entry>The index values must be unique.</entry> + </row> + <row> + <entry>&null;</entry> + <entry>This row is statistics information for the table itself.</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </entry> + </row> + <row> + <entry>INDEX_QUALIFIER</entry> + <entry>A string value representing the qualifier that would have to be + prepended to INDEX_NAME to fully qualify the index.</entry> + </row> + <row> + <entry>INDEX_NAME</entry> + <entry>A string representing the name of the index.</entry> + </row> + <row> + <entry>TYPE</entry> + <entry> + <para> + An integer value representing the type of information contained in + this row of the result set: + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>Return value</entry> + <entry>Parameter type</entry> + </row> + </thead> + <tbody> + <row> + <entry>0 (SQL_TABLE_STAT)</entry> + <entry>The row contains statistics about the table itself.</entry> + </row> + <row> + <entry>1 (SQL_INDEX_CLUSTERED)</entry> + <entry>The row contains information about a clustered index.</entry> + </row> + <row> + <entry>2 (SQL_INDEX_HASH)</entry> + <entry>The row contains information about a hashed index.</entry> + </row> + <row> + <entry>3 (SQL_INDEX_OTHER)</entry> + <entry>The row contains information about a type of index that + is neither clustered nor hashed.</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </entry> + </row> + <row> + <entry>ORDINAL_POSITION</entry> + <entry>The 1-indexed position of the column in the index. &null; if + the row contains statistics information about the table itself.</entry> + </row> + <row> + <entry>COLUMN_NAME</entry> + <entry>The name of the column in the index. &null; if the row + contains statistics information about the table itself.</entry> + </row> + <row> + <entry>ASC_OR_DESC</entry> + <entry> + <literal>A</literal> if the column is sorted in ascending order, + <literal>D</literal> if the column is sorted in descending order, + &null; if the row contains statistics information about the table + itself. + </entry> + </row> + <row> + <entry>CARDINALITY</entry> + <entry> + <para> + If the row contains information about an index, this column contains + an integer value representing the number of unique values in the + index. + </para> + <para> + If the row contains information about the table itself, this column + contains an integer value representing the number of rows in the + table. + </para> + </entry> + </row> + <row> + <entry>PAGES</entry> + <entry> + <para> + If the row contains information about an index, this column contains + an integer value representing the number of pages used to store the + index. + </para> + <para> + If the row contains information about the table itself, this column + contains an integer value representing the number of pages used to + store the table. + </para> + </entry> + </row> + <row> + <entry>FILTER_CONDITION</entry> + <entry>Always returns &null;.</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> - --> - <!-- Use when examples exist <refsect1 role="examples"> @@ -143,19 +291,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_procedures</function></member> + <member><function>db2_special_columns</function></member> + <member><function>db2_table_privileges</function></member> + <member><function>db2_tables</function></member> </simplelist> </para> </refsect1> - --> - </refentry>