sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-15 16:38:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Document db2_foreign_keys and db2_primary_keys.

Browse source 
Add extra see also to db2_column_privileges and db2_columns.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@184807 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Dan Scott 2005-04-21 06:33:25 +00:00
parent f67478942b
commit dc7ee55f87
4 changed files with 217 additions and 151 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
reference/ibm_db2/functions/db2-column-privileges.xml
View file

@ -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-column-privileges">
<refnamediv>
@ -170,6 +170,7 @@ Use the PEAR Coding Standards
<para>
<simplelist>
<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>

3
reference/ibm_db2/functions/db2-columns.xml
View file

@ -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-columns">
<refnamediv>
@ -228,6 +228,7 @@ Use the PEAR Coding Standards
<para>
<simplelist>
<member><function>db2_column_privileges</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>

206
reference/ibm_db2/functions/db2-foreign-keys.xml
View file

@ -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-foreign-keys">
<refnamediv>
@ -14,12 +14,15 @@
<type>resource</type><methodname>db2_foreign_keys</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>
</methodsynopsis>
&warn.undocumented.func;
&warn.experimental.func;
<para>
Returns a result set listing the foreign keys for a table.
</para>
</refsect1>
<refsect1 role="parameters">
@ -28,89 +31,139 @@
<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>
<varlistentry>
<term><parameter>column_name</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
<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.
</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 foreign keys for the specified table. The result set is 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>PKTABLE_CAT</entry>
<entry>
Name of the catalog for the table containing the primary key. The
value is NULL if this table does not have catalogs.
</entry>
</row>
<row>
<entry>PKTABLE_SCHEM</entry>
<entry>
Name of the schema for the table containing the primary key.
</entry>
</row>
<row>
<entry>PKTABLE_NAME</entry>
<entry>Name of the table containing the primary key.</entry>
</row>
<row>
<entry>PKCOLUMN_NAME</entry>
<entry>Name of the column containing the primary key.</entry>
</row>
<row>
<entry>FKTABLE_CAT</entry>
<entry>
Name of the catalog for the table containing the foreign key. The
value is NULL if this table does not have catalogs.
</entry>
</row>
<row>
<entry>FKTABLE_SCHEM</entry>
<entry>
Name of the schema for the table containing the foreign key.
</entry>
</row>
<row>
<entry>FKTABLE_NAME</entry>
<entry>Name of the table containing the foreign key.</entry>
</row>
<row>
<entry>FKCOLUMN_NAME</entry>
<entry>Name of the column containing the foreign key.</entry>
</row>
<row>
<entry>KEY_SEQ</entry>
<entry>1-indexed position of the column in the key.</entry>
</row>
<row>
<entry>UPDATE_RULE</entry>
<entry>
Integer value representing the action applied to the foreign key
when the SQL operation is UPDATE.
</entry>
</row>
<row>
<entry>DELETE_RULE</entry>
<entry>
Integer value representing the action applied to the foreign key
when the SQL operation is DELETE.
</entry>
</row>
<row>
<entry>FK_NAME</entry>
<entry>The name of the foreign key.</entry>
</row>
<row>
<entry>PK_NAME</entry>
<entry>The name of the primary key.</entry>
</row>
<row>
<entry>DEFERRABILITY</entry>
<entry>
An integer value representing whether the foreign key deferrability is
SQL_INITIALLY_DEFERRED, SQL_INITIALLY_IMMEDIATE, or
SQL_NOT_DEFERRABLE.
</entry>
</row>
</tbody>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
@ -143,19 +196,22 @@ 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_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>

156
reference/ibm_db2/functions/db2-primary-keys.xml
View file

@ -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-primary-keys">
<refnamediv>
@ -14,12 +14,14 @@
<type>resource</type><methodname>db2_primary_keys</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>
</methodsynopsis>
&warn.undocumented.func;
&warn.experimental.func;
<para>
Returns a result set listing the primary keys for a table.
</para>
</refsect1>
<refsect1 role="parameters">
@ -28,89 +30,91 @@
<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>
<varlistentry>
<term><parameter>column_name</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
<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.
</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 primary keys for the specified table. The result set is 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 for the table containing the primary key. The
value is NULL if this table does not have catalogs.
</entry>
</row>
<row>
<entry>TABLE_SCHEM</entry>
<entry>
Name of the schema for the table containing the primary key.
</entry>
</row>
<row>
<entry>TABLE_NAME</entry>
<entry>Name of the table containing the primary key.</entry>
</row>
<row>
<entry>COLUMN_NAME</entry>
<entry>Name of the column containing the primary key.</entry>
</row>
<row>
<entry>KEY_SEQ</entry>
<entry>1-indexed position of the column in the key.</entry>
</row>
<row>
<entry>PK_NAME</entry>
<entry>The name of the primary key.</entry>
</row>
</tbody>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
@ -143,18 +147,22 @@ 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_columns</function></member>
<member><function>db2_foreign_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>