odbc-foreignkeys.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.odbc-foreignkeys" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>odbc_foreignkeys</refname>
  <refpurpose>Retrieves a list of foreign keys</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <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_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_table</parameter></methodparam>
  </methodsynopsis>
  <para>
   Retrieves a list of foreign keys in the specified table or a list of
   foreign keys in other tables that refer to the primary key in the
   specified table
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection_id</parameter></term>
     <listitem>
      &odbc.connection.id;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>pk_qualifier</parameter></term>
     <listitem>
      <para>
       The primary key qualifier.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>pk_owner</parameter></term>
     <listitem>
      <para>
       The primary key owner.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>pk_table</parameter></term>
     <listitem>
      <para>
       The primary key table.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>fk_qualifier</parameter></term>
     <listitem>
      <para>
       The foreign key qualifier.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>fk_owner</parameter></term>
     <listitem>
      <para>
       The foreign key owner.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>fk_table</parameter></term>
     <listitem>
      <para>
       The foreign key table.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an ODBC result identifier&return.falseforfailure;.
  </para>
  <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>
   </itemizedlist>
  </para>
  <simpara>
   If <parameter>pk_table</parameter> contains a table name,
   <function>odbc_foreignkeys</function> returns a result set
   containing the primary key of the specified table and all of the
   foreign keys that refer to it.
  </simpara>
  <simpara>
   If <parameter>fk_table</parameter> contains a table name,
   <function>odbc_foreignkeys</function> returns a result set
   containing all of the foreign keys in the specified table and the
   primary keys (in other tables) to which they refer.
  </simpara>
  <simpara>
   If both <parameter>pk_table</parameter> and
   <parameter>fk_table</parameter> contain table names,
   <function>odbc_foreignkeys</function> returns the foreign keys in
   the table specified in <parameter>fk_table</parameter> that refer
   to the primary key of the table specified in
   <parameter>pk_table</parameter>. This should be one key at most.
  </simpara>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->