From 44edcd5392b329227f2ac75856816b9786cdad60 Mon Sep 17 00:00:00 2001
From: Dan Scott <dbs@php.net>
Date: Thu, 21 Apr 2005 01:02:04 +0000
Subject: [PATCH] Stab at db2_column_privileges and db2_columns functions.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@184794 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../functions/db2-column-privileges.xml       | 172 +++++++------
 reference/ibm_db2/functions/db2-columns.xml   | 232 ++++++++++++------
 2 files changed, 255 insertions(+), 149 deletions(-)

diff --git a/reference/ibm_db2/functions/db2-column-privileges.xml b/reference/ibm_db2/functions/db2-column-privileges.xml
index aa3882039d..c487d25609 100644
--- a/reference/ibm_db2/functions/db2-column-privileges.xml
+++ b/reference/ibm_db2/functions/db2-column-privileges.xml
@@ -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-column-privileges">
  <refnamediv>
@@ -14,12 +14,17 @@
    <type>resource</type><methodname>db2_column_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><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>
   </methodsynopsis>
 
-  &warn.undocumented.func;
+  &warn.experimental.func;
+
+  <para>
+   Returns a result set listing the columns and associated privileges for a
+   table.
+  </para>
 
  </refsect1>
  <refsect1 role="parameters">
@@ -28,89 +33,106 @@
    <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. 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>
+     <term><parameter>table-name</parameter></term>
+     <listitem>
+      <para>
+       The name of the table or view. To match all tables in the database,
+       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>column-name</parameter></term>
+     <listitem>
+      <para>
+       The name of the column. To match all columns in the table, 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 column privileges for columns matching the specified parameters. The
+   rows are composed of the following columns:
    <informaltable>
-    <tgroup cols="2">
+    <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>
-     </tbody>
     </tgroup>
+    <tbody>
+      <row>
+       <entry>TABLE_CAT</entry>
+       <entry>Name of the catalog. The value is NULL if this table does not
+        have catalogs.</entry>
+      </row>
+      <row>
+       <entry>TABLE_SCHEM</entry>
+       <entry>Name of the schema.</entry>
+      </row>
+      <row>
+       <entry>TABLE_NAME</entry>
+       <entry>Name of the table or view.</entry>
+      </row>
+      <row>
+       <entry>COLUMN_NAME</entry>
+       <entry>Name of the column.</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 for the column.</entry>
+      </row>
+      <row>
+       <entry>IS_GRANTABLE</entry>
+       <entry>Whether the GRANTEE is permitted to grant this privilege to
+       other users.</entry>
+      </row>
+    </tbody>
    </informaltable>
   </para>
  </refsect1>
- -->
-
 
  <!-- Use when examples exist
  <refsect1 role="examples">
@@ -143,19 +165,21 @@ Use the PEAR Coding Standards
  </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_columns</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>
+    <member><function>db2_tables</function></member>
    </simplelist>
   </para>
  </refsect1>
- -->
-
 
 </refentry>
 
diff --git a/reference/ibm_db2/functions/db2-columns.xml b/reference/ibm_db2/functions/db2-columns.xml
index 11d46ad94a..143d7061b1 100644
--- a/reference/ibm_db2/functions/db2-columns.xml
+++ b/reference/ibm_db2/functions/db2-columns.xml
@@ -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-columns">
  <refnamediv>
@@ -14,12 +14,16 @@
    <type>resource</type><methodname>db2_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>table-name</parameter></methodparam>
+   <methodparam><type>string</type><parameter>column-name</parameter></methodparam>
   </methodsynopsis>
 
-  &warn.undocumented.func;
+  &warn.experimental.func;
+  <para>
+   Returns a result set listing the columns and associated metadata for a
+   table.
+  </para>
 
  </refsect1>
  <refsect1 role="parameters">
@@ -28,89 +32,165 @@
    <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>
+    <term><parameter>qualifier</parameter></term>
+     <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. 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>
+     <term><parameter>table-name</parameter></term>
+     <listitem>
+      <para>
+       The name of the table or view. To match all tables in the database,
+       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>column-name</parameter></term>
+     <listitem>
+      <para>
+       The name of the column. To match all columns in the table, 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 columns matching the specified parameters. The rows are composed of
+   the following columns:
    <informaltable>
-    <tgroup cols="2">
+    <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>
-     </tbody>
     </tgroup>
+    <tbody>
+      <row>
+       <entry>TABLE_CAT</entry>
+       <entry>Name of the catalog. The value is NULL if this table does not
+        have catalogs.</entry>
+      </row>
+      <row>
+       <entry>TABLE_SCHEM</entry>
+       <entry>Name of the schema.</entry>
+      </row>
+      <row>
+       <entry>TABLE_NAME</entry>
+       <entry>Name of the table or view.</entry>
+      </row>
+      <row>
+       <entry>COLUMN_NAME</entry>
+       <entry>Name of the column.</entry>
+      </row>
+      <row>
+       <entry>DATA_TYPE</entry>
+       <entry>The SQL data type for the column represented as an integer value.</entry>
+      </row>
+      <row>
+       <entry>TYPE_NAME</entry>
+       <entry>A string representing the 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>NULLABLE</entry>
+       <entry>An integer value representing whether the column is nullable or
+       not.</entry>
+      </row>
+      <row>
+       <entry>REMARKS</entry>
+       <entry>Description of the column.</entry>
+      </row>
+      <row>
+       <entry>COLUMN_DEF</entry>
+       <entry>Default value for the column.</entry>
+      </row>
+      <row>
+       <entry>SQL_DATA_TYPE</entry>
+       <entry>An integer value representing the size of the column.</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 column, 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 column in the table.</entry>
+      </row>
+      <row>
+       <entry>IS_NULLABLE</entry>
+       <entry>
+        A string value where 'YES' means that the column is nullable and
+        'NO' means that the column is not nullable.
+      </entry>
+      </row>
+    </tbody>
    </informaltable>
+
   </para>
  </refsect1>
- -->
-
 
  <!-- Use when examples exist
  <refsect1 role="examples">
@@ -143,19 +223,21 @@ Use the PEAR Coding Standards
  </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_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>
+    <member><function>db2_tables</function></member>
    </simplelist>
   </para>
  </refsect1>
- -->
-
 
 </refentry>