dbs Fri Apr 29 23:30:59 2005 EDT
Modified files:
/phpdoc/en/reference/ibm_db2/functions db2-special-columns.xml
db2-table-privileges.xml
Log:
Document two more metadata functions.
http://cvs.php.net/diff.php/phpdoc/en/reference/ibm_db2/functions/db2-special-columns.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ibm_db2/functions/db2-special-columns.xml
diff -u phpdoc/en/reference/ibm_db2/functions/db2-special-columns.xml:1.1
phpdoc/en/reference/ibm_db2/functions/db2-special-columns.xml:1.2
--- phpdoc/en/reference/ibm_db2/functions/db2-special-columns.xml:1.1 Tue Apr
12 17:12:48 2005
+++ phpdoc/en/reference/ibm_db2/functions/db2-special-columns.xml Fri Apr
29 23:30:59 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-special-columns">
<refnamediv>
@@ -14,12 +14,16 @@
<type>resource</type><methodname>db2_special_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>schema</parameter></methodparam>
<methodparam><type>string</type><parameter>table_name</parameter></methodparam>
<methodparam><type>string</type><parameter>column_name</parameter></methodparam>
+ <methodparam><type>long</type><parameter>scope</parameter></methodparam>
</methodsynopsis>
- &warn.undocumented.func;
+ &warn.experimental.func;
+ <para>
+ Returns a result set listing the unique row identifier columns for a table.
+ </para>
</refsect1>
<refsect1 role="parameters">
@@ -28,89 +32,190 @@
<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>
- <varlistentry>
- <term><parameter>owner</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>schema</parameter></term>
+ <listitem>
+ <para>
+ The schema which contains the tables.
+ </para>
+ </listitem>
+ </varlistentry>
<varlistentry>
<term><parameter>table_name</parameter></term>
- <listitem>
- <para>
- Its description
- </para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>
+ The name of the table.
+ </para>
+ </listitem>
+ </varlistentry>
<varlistentry>
<term><parameter>column_name</parameter></term>
- <listitem>
- <para>
- Its description
- </para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>
+ The name of the column.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>scope</parameter></term>
+ <listitem>
+ <para>
+ Integer value representing the minimum duration for which the
+ unique row identifier is valid. This can be one of the following
+ values:
+ <informaltable>
+ <tgroup cols="3">
+ <thead>
+ <row>
+ <entry>Integer value</entry>
+ <entry>SQL constant</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>0</entry>
+ <entry>SQL_SCOPE_CURROW</entry>
+ <entry>Row identifier is valid only while the curosr is positioned
+ on the row.</entry>
+ </row>
+ <row>
+ <entry>1</entry>
+ <entry>SQL_SCOPE_TRANSACTION</entry>
+ <entry>Row identifier is valid for the duration of the
+ transaction.</entry>
+ </row>
+ <row>
+ <entry>2</entry>
+ <entry>SQL_SCOPE_SESSION</entry>
+ <entry>Row identifier is valid for the duration of the
+ connection</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </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 with unique
+ row identifier information for a table. 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>SCOPE</entry>
+ <entry>
+ <para>
+ <informaltable>
+ <tgroup cols="3">
+ <thead>
+ <row>
+ <entry>Integer value</entry>
+ <entry>SQL constant</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>0</entry>
+ <entry>SQL_SCOPE_CURROW</entry>
+ <entry>Row identifier is valid only while the curosr is
positioned
+ on the row.</entry>
+ </row>
+ <row>
+ <entry>1</entry>
+ <entry>SQL_SCOPE_TRANSACTION</entry>
+ <entry>Row identifier is valid for the duration of the
+ transaction.</entry>
+ </row>
+ <row>
+ <entry>2</entry>
+ <entry>SQL_SCOPE_SESSION</entry>
+ <entry>Row identifier is valid for the duration of the
+ connection</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>COLUMN_NAME</entry>
+ <entry>Name of the unique column.</entry>
+ </row>
+ <row>
+ <entry>DATA_TYPE</entry>
+ <entry>SQL data type for the column.</entry>
+ </row>
+ <row>
+ <entry>TYPE_NAME</entry>
+ <entry>Character string representation of the SQL data type for the
+ column.</entry>
+ </row>
+ <row>
+ <entry>COLUMN_SIZE</entry>
+ <entry>An integer value representing the size of the column.</entry>
+ </row>
+ <row>
+ <entry>BUFFER_LENGTH</entry>
+ <entry>
+ Maximum number of bytes necessary to store data from this column.
+ </entry>
+ </row>
+ <row>
+ <entry>DECIMAL_DIGITS</entry>
+ <entry>
+ The scale of the column, 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>PSEUDO_COLUMN</entry>
+ <entry>Always returns 1.</entry>
+ </row>
</tbody>
</tgroup>
</informaltable>
+
</para>
</refsect1>
- -->
-
<!-- Use when examples exist
<refsect1 role="examples">
@@ -143,19 +248,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_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-table-privileges.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ibm_db2/functions/db2-table-privileges.xml
diff -u phpdoc/en/reference/ibm_db2/functions/db2-table-privileges.xml:1.1
phpdoc/en/reference/ibm_db2/functions/db2-table-privileges.xml:1.2
--- phpdoc/en/reference/ibm_db2/functions/db2-table-privileges.xml:1.1 Tue Apr
12 17:12:48 2005
+++ phpdoc/en/reference/ibm_db2/functions/db2-table-privileges.xml Fri Apr
29 23:30:59 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-table-privileges">
<refnamediv>
@@ -13,13 +13,16 @@
<methodsynopsis>
<type>resource</type><methodname>db2_table_privileges</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
choice="opt"><type>string</type><parameter>qualifier</parameter></methodparam>
+ <methodparam
choice="opt"><type>string</type><parameter>schema</parameter></methodparam>
+ <methodparam
choice="opt"><type>string</type><parameter>table_name</parameter></methodparam>
</methodsynopsis>
- &warn.undocumented.func;
+ &warn.experimental.func;
+ <para>
+ Returns a result set listing the tables and associated privileges in a
+ database.
+ </para>
</refsect1>
<refsect1 role="parameters">
@@ -28,89 +31,100 @@
<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>
- <varlistentry>
- <term><parameter>column_name</parameter></term>
- <listitem>
- <para>
- Its description
- </para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>
+ The name of the table. This parameter accepts a search pattern
+ containing <literal>_</literal> and <literal>%</literal> as wildcards.
+ </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 privileges for 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>GRANTOR</entry>
+ <entry>Authorization ID of the user who granted the privilege.</entry>
+ </row>
+ <row>
+ <entry>GRANTEE</entry>
+ <entry>Authorization ID of the user to whom the privilege was
+ granted.</entry>
+ </row>
+ <row>
+ <entry>PRIVILEGE</entry>
+ <entry>
+ The privilege that has been granted. This can be one of ALTER,
+ CONTROL, DELETE, INDEX, INSERT, REFERENCES, SELECT, or UPDATE.
+ </entry>
+ </row>
+ <row>
+ <entry>IS_GRANTABLE</entry>
+ <entry>
+ A string value of "YES" or "NO" indicating whether the grantee
+ can grant the privilege to other users.
+ </entry>
</row>
</tbody>
</tgroup>
</informaltable>
+
</para>
</refsect1>
- -->
-
<!-- Use when examples exist
<refsect1 role="examples">
@@ -143,18 +157,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_tables</function></member>
</simplelist>
</para>
</refsect1>
- -->
</refentry>
