dbs Fri Apr 29 19:38:48 2005 EDT
Modified files:
/phpdoc/en/reference/ibm_db2/functions db2-columns.xml
db2-foreign-keys.xml
db2-primary-keys.xml
db2-procedure-columns.xml
db2-procedures.xml
db2-tables.xml
Log:
Correct lies about some metadata function parameter values.
http://cvs.php.net/diff.php/phpdoc/en/reference/ibm_db2/functions/db2-columns.xml?r1=1.4&r2=1.5&ty=u
Index: phpdoc/en/reference/ibm_db2/functions/db2-columns.xml
diff -u phpdoc/en/reference/ibm_db2/functions/db2-columns.xml:1.4
phpdoc/en/reference/ibm_db2/functions/db2-columns.xml:1.5
--- phpdoc/en/reference/ibm_db2/functions/db2-columns.xml:1.4 Sat Apr 23
18:37:14 2005
+++ phpdoc/en/reference/ibm_db2/functions/db2-columns.xml Fri Apr 29
19:38:47 2005
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc.
-->
<refentry id="function.db2-columns">
<refnamediv>
@@ -51,8 +51,8 @@
<term><parameter>schema</parameter></term>
<listitem>
<para>
- The schema which contains the tables. To match all schemas, pass &null;
- or an empty string.
+ The schema which contains the tables. To match all schemas, pass
+ <literal>'%'</literal>.
</para>
</listitem>
</varlistentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/ibm_db2/functions/db2-foreign-keys.xml?r1=1.3&r2=1.4&ty=u
Index: phpdoc/en/reference/ibm_db2/functions/db2-foreign-keys.xml
diff -u phpdoc/en/reference/ibm_db2/functions/db2-foreign-keys.xml:1.3
phpdoc/en/reference/ibm_db2/functions/db2-foreign-keys.xml:1.4
--- phpdoc/en/reference/ibm_db2/functions/db2-foreign-keys.xml:1.3 Sat Apr
23 18:37:14 2005
+++ phpdoc/en/reference/ibm_db2/functions/db2-foreign-keys.xml Fri Apr 29
19:38:47 2005
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc.
-->
<refentry id="function.db2-foreign-keys">
<refnamediv>
@@ -50,8 +50,9 @@
<term><parameter>schema</parameter></term>
<listitem>
<para>
- The schema which contains the tables. To match all schemas, pass &null;
- or an empty string.
+ The schema which contains the tables. If <parameter>schema</parameter>
+ is &null;, <function>db2_foreign_keys</function> matches the schema for
+ the current connection.
</para>
</listitem>
</varlistentry>
@@ -59,8 +60,7 @@
<term><parameter>table-name</parameter></term>
<listitem>
<para>
- The name of the table. To match all tables in the database, pass &null;
- or an empty string.
+ The name of the table.
</para>
</listitem>
</varlistentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/ibm_db2/functions/db2-primary-keys.xml?r1=1.3&r2=1.4&ty=u
Index: phpdoc/en/reference/ibm_db2/functions/db2-primary-keys.xml
diff -u phpdoc/en/reference/ibm_db2/functions/db2-primary-keys.xml:1.3
phpdoc/en/reference/ibm_db2/functions/db2-primary-keys.xml:1.4
--- phpdoc/en/reference/ibm_db2/functions/db2-primary-keys.xml:1.3 Sat Apr
23 18:37:14 2005
+++ phpdoc/en/reference/ibm_db2/functions/db2-primary-keys.xml Fri Apr 29
19:38:47 2005
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc.
-->
<refentry id="function.db2-primary-keys">
<refnamediv>
@@ -49,8 +49,9 @@
<term><parameter>schema</parameter></term>
<listitem>
<para>
- The schema which contains the tables. To match all schemas, pass &null;
- or an empty string.
+ The schema which contains the tables. If <parameter>schema</parameter>
+ is &null;, <function>db2_primary_keys</function> matches the schema for
+ the current connection.
</para>
</listitem>
</varlistentry>
@@ -58,8 +59,7 @@
<term><parameter>table-name</parameter></term>
<listitem>
<para>
- The name of the table. To match all tables in the database, pass &null;
- or an empty string.
+ The name of the table.
</para>
</listitem>
</varlistentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/ibm_db2/functions/db2-procedure-columns.xml?r1=1.2&r2=1.3&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.2
phpdoc/en/reference/ibm_db2/functions/db2-procedure-columns.xml:1.3
--- phpdoc/en/reference/ibm_db2/functions/db2-procedure-columns.xml:1.2 Fri Apr
29 12:23:16 2005
+++ phpdoc/en/reference/ibm_db2/functions/db2-procedure-columns.xml Fri Apr
29 19:38:47 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-procedure-columns">
<refnamediv>
@@ -42,8 +42,8 @@
<term><parameter>qualifier</parameter></term>
<listitem>
<para>
- The schema which contains the procedures. To match all schemas, pass
- &null; or an empty string.
+ 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>
@@ -51,8 +51,9 @@
<term><parameter>schema</parameter></term>
<listitem>
<para>
- The schema which contains the procedures. To match all schemas, pass
- &null; or an empty string.
+ The schema which contains the procedures. This parameter accepts a
+ search pattern containing <literal>_</literal> and <literal>%</literal>
+ as wildcards.
</para>
</listitem>
</varlistentry>
@@ -60,8 +61,9 @@
<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.
+ The name of the procedure. This parameter accepts a
+ search pattern containing <literal>_</literal> and <literal>%</literal>
+ as wildcards.
</para>
</listitem>
</varlistentry>
@@ -69,8 +71,10 @@
<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.
+ The name of the parameter. This parameter accepts a search pattern
+ containing <literal>_</literal> and <literal>%</literal> as wildcards.
+ If this parameter is &null;, all parameters for the specified stored
+ procedures are returned.
</para>
</listitem>
</varlistentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/ibm_db2/functions/db2-procedures.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/reference/ibm_db2/functions/db2-procedures.xml
diff -u phpdoc/en/reference/ibm_db2/functions/db2-procedures.xml:1.2
phpdoc/en/reference/ibm_db2/functions/db2-procedures.xml:1.3
--- phpdoc/en/reference/ibm_db2/functions/db2-procedures.xml:1.2 Fri Apr
29 12:23:16 2005
+++ phpdoc/en/reference/ibm_db2/functions/db2-procedures.xml Fri Apr 29
19:38:47 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-procedures">
<refnamediv>
@@ -51,8 +51,9 @@
<term><parameter>schema</parameter></term>
<listitem>
<para>
- The schema which contains the procedures. To match all schemas, pass
- &null; or an empty string.
+ The schema which contains the procedures. This parameter accepts a
+ search pattern containing <literal>_</literal> and <literal>%</literal>
+ as wildcards.
</para>
</listitem>
</varlistentry>
@@ -60,8 +61,9 @@
<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.
+ The name of the procedure. This parameter accepts a
+ search pattern containing <literal>_</literal> and <literal>%</literal>
+ as wildcards.
</para>
</listitem>
</varlistentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/ibm_db2/functions/db2-tables.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ibm_db2/functions/db2-tables.xml
diff -u phpdoc/en/reference/ibm_db2/functions/db2-tables.xml:1.1
phpdoc/en/reference/ibm_db2/functions/db2-tables.xml:1.2
--- phpdoc/en/reference/ibm_db2/functions/db2-tables.xml:1.1 Tue Apr 12
17:12:48 2005
+++ phpdoc/en/reference/ibm_db2/functions/db2-tables.xml Fri Apr 29
19:38:47 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-tables">
<refnamediv>
@@ -14,12 +14,16 @@
<type>resource</type><methodname>db2_tables</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>table_type</parameter></methodparam>
+ <methodparam><type>string</type><parameter>schema</parameter></methodparam>
+
<methodparam><type>string</type><parameter>table-name</parameter></methodparam>
+
<methodparam><type>string</type><parameter>table-type</parameter></methodparam>
</methodsynopsis>
- &warn.undocumented.func;
+ &warn.experimental.func;
+ <para>
+ Returns a result set listing the tables and associated metadata in a
+ database.
+ </para>
</refsect1>
<refsect1 role="parameters">
@@ -28,89 +32,96 @@
<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 tables. This parameter accepts a
+ search pattern containing <literal>_</literal> and <literal>%</literal>
+ as wildcards.
+ </para>
+ </listitem>
+ </varlistentry>
<varlistentry>
- <term><parameter>table_name</parameter></term>
- <listitem>
- <para>
- Its description
- </para>
- </listitem>
- </varlistentry>
+ <term><parameter>table-name</parameter></term>
+ <listitem>
+ <para>
+ The name of the table. This parameter accepts a search pattern
+ containing <literal>_</literal> and <literal>%</literal> as wildcards.
+ </para>
+ </listitem>
+ </varlistentry>
<varlistentry>
- <term><parameter>table_type</parameter></term>
- <listitem>
- <para>
- Its description
- </para>
- </listitem>
- </varlistentry>
+ <term><parameter>table-type</parameter></term>
+ <listitem>
+ <para>
+ A list of comma-delimited table type identifiers. To match all table
+ types, pass &null; or an empty string. Valid table type identifiers
+ include: ALIAS, HIERARCHY TABLE, INOPERATIVE VIEW, NICKNAME,
+ MATERIALIZED QUERY TABLE, SYSTEM TABLE, TABLE, TYPED TABLE, TYPED VIEW,
+ and VIEW.
+ </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 tables that match 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>TABLE_TYPE</entry>
+ <entry>Table type identifier for the table.</entry>
+ </row>
+ <row>
+ <entry>REMARKS</entry>
+ <entry>Description of the table.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
- -->
-
<!-- Use when examples exist
<refsect1 role="examples">
@@ -143,19 +154,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_statistics</function></member>
+ <member><function>db2_table_privileges</function></member>
</simplelist>
</para>
</refsect1>
- -->
-
</refentry>
