From b929019816db6bc783ec7b4b53a2c5abec44854e Mon Sep 17 00:00:00 2001
From: Christoph Michael Becker <cmb@php.net>
Date: Thu, 24 Sep 2020 21:41:16 +0000
Subject: [PATCH] Update and improve odbc_foreignkeys() docs

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@350626 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../uodbc/functions/odbc-foreignkeys.xml      | 70 ++++++++++++-------
 .../uodbc/functions/odbc-primarykeys.xml      |  1 +
 2 files changed, 46 insertions(+), 25 deletions(-)

diff --git a/reference/uodbc/functions/odbc-foreignkeys.xml b/reference/uodbc/functions/odbc-foreignkeys.xml
index 36729bf0bd..9eeabb1cd9 100644
--- a/reference/uodbc/functions/odbc-foreignkeys.xml
+++ b/reference/uodbc/functions/odbc-foreignkeys.xml
@@ -11,11 +11,11 @@
   <methodsynopsis>
    <type>resource</type><methodname>odbc_foreignkeys</methodname>
    <methodparam><type>resource</type><parameter>connection_id</parameter></methodparam>
-   <methodparam><type>string</type><parameter>pk_qualifier</parameter></methodparam>
-   <methodparam><type>string</type><parameter>pk_owner</parameter></methodparam>
+   <methodparam><type>string</type><parameter>pk_catalog</parameter></methodparam>
+   <methodparam><type>string</type><parameter>pk_schema</parameter></methodparam>
    <methodparam><type>string</type><parameter>pk_table</parameter></methodparam>
-   <methodparam><type>string</type><parameter>fk_qualifier</parameter></methodparam>
-   <methodparam><type>string</type><parameter>fk_owner</parameter></methodparam>
+   <methodparam><type>string</type><parameter>fk_catalog</parameter></methodparam>
+   <methodparam><type>string</type><parameter>fk_schema</parameter></methodparam>
    <methodparam><type>string</type><parameter>fk_table</parameter></methodparam>
   </methodsynopsis>
   <para>
@@ -36,18 +36,18 @@
      </listitem>
     </varlistentry>
     <varlistentry>
-     <term><parameter>pk_qualifier</parameter></term>
+     <term><parameter>pk_catalog</parameter></term>
      <listitem>
       <para>
-       The primary key qualifier.
+       The catalog (&apos;qualifier&apos; in ODBC 2 parlance) of the primary key table.
       </para>
      </listitem>
     </varlistentry>
     <varlistentry>
-     <term><parameter>pk_owner</parameter></term>
+     <term><parameter>pk_schema</parameter></term>
      <listitem>
       <para>
-       The primary key owner.
+       The schema (&apos;owner&apos; in ODBC 2 parlance) of the primary key table.
       </para>
      </listitem>
     </varlistentry>
@@ -60,18 +60,18 @@
      </listitem>
     </varlistentry>
     <varlistentry>
-     <term><parameter>fk_qualifier</parameter></term>
+     <term><parameter>pk_catalog</parameter></term>
      <listitem>
       <para>
-       The foreign key qualifier.
+       The catalog (&apos;qualifier&apos; in ODBC 2 parlance) of the foreign key table.
       </para>
      </listitem>
     </varlistentry>
     <varlistentry>
-     <term><parameter>fk_owner</parameter></term>
+     <term><parameter>fk_schema</parameter></term>
      <listitem>
       <para>
-       The foreign key owner.
+       The schema (&apos;owner&apos; in ODBC 2 parlance) of the foreign key table.
       </para>
      </listitem>
     </varlistentry>
@@ -95,21 +95,31 @@
   <para>
    The result set has the following columns:
    <itemizedlist>
-    <listitem><simpara>PKTABLE_QUALIFIER</simpara></listitem>
-    <listitem><simpara>PKTABLE_OWNER</simpara></listitem>
-    <listitem><simpara>PKTABLE_NAME</simpara></listitem>
-    <listitem><simpara>PKCOLUMN_NAME</simpara></listitem>
-    <listitem><simpara>FKTABLE_QUALIFIER</simpara></listitem>
-    <listitem><simpara>FKTABLE_OWNER</simpara></listitem>
-    <listitem><simpara>FKTABLE_NAME</simpara></listitem>
-    <listitem><simpara>FKCOLUMN_NAME</simpara></listitem>
-    <listitem><simpara>KEY_SEQ</simpara></listitem>
-    <listitem><simpara>UPDATE_RULE</simpara></listitem>
-    <listitem><simpara>DELETE_RULE</simpara></listitem>
-    <listitem><simpara>FK_NAME</simpara></listitem>
-    <listitem><simpara>PK_NAME</simpara></listitem>
+    <listitem><simpara><literal>PKTABLE_CAT</literal></simpara></listitem>
+    <listitem><simpara><literal>PKTABLE_SCHEM</literal></simpara></listitem>
+    <listitem><simpara><literal>PKTABLE_NAME</literal></simpara></listitem>
+    <listitem><simpara><literal>PKCOLUMN_NAME</literal></simpara></listitem>
+    <listitem><simpara><literal>FKTABLE_CAT</literal></simpara></listitem>
+    <listitem><simpara><literal>FKTABLE_SCHEM</literal></simpara></listitem>
+    <listitem><simpara><literal>FKTABLE_NAME</literal></simpara></listitem>
+    <listitem><simpara><literal>FKCOLUMN_NAME</literal></simpara></listitem>
+    <listitem><simpara><literal>KEY_SEQ</literal></simpara></listitem>
+    <listitem><simpara><literal>UPDATE_RULE</literal></simpara></listitem>
+    <listitem><simpara><literal>DELETE_RULE</literal></simpara></listitem>
+    <listitem><simpara><literal>FK_NAME</literal></simpara></listitem>
+    <listitem><simpara><literal>PK_NAME</literal></simpara></listitem>
+    <listitem><simpara><literal>DEFERRABILITY</literal></simpara></listitem>
    </itemizedlist>
+   &odbc.result.driver-specific;
   </para>
+  <simpara>
+   If the foreign keys associated with a primary key are requested, the result set
+   is ordered by <literal>FKTABLE_CAT</literal>, <literal>FKTABLE_SCHEM</literal>,
+   <literal>FKTABLE_NAME</literal> and <literal>KEY_SEQ</literal>.
+   If the primary keys associated with a foreign key are requested, the result set
+   is ordered by <literal>PKTABLE_CAT</literal>, <literal>PKTABLE_SCHEM</literal>,
+   <literal>PKTABLE_NAME</literal> and <literal>KEY_SEQ</literal>.
+  </simpara>
   <simpara>
    If <parameter>pk_table</parameter> contains a table name,
    <function>odbc_foreignkeys</function> returns a result set
@@ -132,6 +142,16 @@
   </simpara>
  </refsect1>
 
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>odbc_tables</function></member>
+    <member><function>odbc_primarykeys</function></member>
+   </simplelist>
+  </para>
+ </refsect1>
+
 </refentry>
 
 <!-- Keep this comment at the end of the file
diff --git a/reference/uodbc/functions/odbc-primarykeys.xml b/reference/uodbc/functions/odbc-primarykeys.xml
index 11351e75df..b62609e076 100644
--- a/reference/uodbc/functions/odbc-primarykeys.xml
+++ b/reference/uodbc/functions/odbc-primarykeys.xml
@@ -116,6 +116,7 @@ Array
   <para>
    <simplelist>
     <member><function>odbc_tables</function></member>
+    <member><function>odbc_foreignkeys</function></member>
    </simplelist>
   </para>
  </refsect1>