Source of: /manual/en/function.odbc-foreignkeys.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.uodbc.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.odbc-foreignkeys.php',
1 => 'odbc_foreignkeys',
),
'up' =>
array (
0 => 'ref.uodbc.php',
1 => 'ODBC Functions',
),
'prev' =>
array (
0 => 'function.odbc-field-type.php',
1 => 'odbc_field_type',
),
'next' =>
array (
0 => 'function.odbc-free-result.php',
1 => 'odbc_free_result',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.odbc-foreignkeys" class="refentry">
<div class="refnamediv">
<h1 class="refname">odbc_foreignkeys</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">odbc_foreignkeys</span> — <span class="dc-title">Retrieves a list of foreign keys</span></p>
</div>
<a name="function.odbc-foreignkeys.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <span class="methodname"><b>odbc_foreignkeys</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$connection_id</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$pk_qualifier</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$pk_owner</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$pk_table</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$fk_qualifier</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$fk_owner</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$fk_table</tt></span>
)</div>
<p class="para rdfs-comment">
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
</p>
</div>
<a name="function.odbc-foreignkeys.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">connection_id</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">The ODBC connection identifier,
see <a href="function.odbc-connect.php" class="function">odbc_connect()</a> for details.</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">pk_qualifier</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The primary key qualifier.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">pk_owner</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The primary key owner.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">pk_table</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The primary key table.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">fk_qualifier</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The foreign key qualifier.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">fk_owner</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The foreign key owner.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">fk_table</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The foreign key table.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.odbc-foreignkeys.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an ODBC result identifier or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
<p class="para">
The result set has the following columns:
</p><ul class="itemizedlist">
<li class="listitem"><span class="simpara">PKTABLE_QUALIFIER</span></li>
<li class="listitem"><span class="simpara">PKTABLE_OWNER</span></li>
<li class="listitem"><span class="simpara">PKTABLE_NAME</span></li>
<li class="listitem"><span class="simpara">PKCOLUMN_NAME</span></li>
<li class="listitem"><span class="simpara">FKTABLE_QUALIFIER</span></li>
<li class="listitem"><span class="simpara">FKTABLE_OWNER</span></li>
<li class="listitem"><span class="simpara">FKTABLE_NAME</span></li>
<li class="listitem"><span class="simpara">FKCOLUMN_NAME</span></li>
<li class="listitem"><span class="simpara">KEY_SEQ</span></li>
<li class="listitem"><span class="simpara">UPDATE_RULE</span></li>
<li class="listitem"><span class="simpara">DELETE_RULE</span></li>
<li class="listitem"><span class="simpara">FK_NAME</span></li>
<li class="listitem"><span class="simpara">PK_NAME</span></li>
</ul><p>
</p>
<p class="simpara">
If <i><tt class="parameter">pk_table</tt></i>
contains a table name,
<b>odbc_foreignkeys()</b> returns a result set
containing the primary key of the specified table and all of the
foreign keys that refer to it.
</p>
<p class="simpara">
If <i><tt class="parameter">fk_table</tt></i>
contains a table name,
<b>odbc_foreignkeys()</b> 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.
</p>
<p class="simpara">
If both <i><tt class="parameter">pk_table</tt></i>
and
<i><tt class="parameter">fk_table</tt></i>
contain table names,
<b>odbc_foreignkeys()</b> returns the foreign keys in
the table specified in <i><tt class="parameter">fk_table</tt></i>
that refer
to the primary key of the table specified in
<i><tt class="parameter">pk_table</tt></i>
. This should be one key at most.
</p>
</div>
</div><?php manual_footer(); ?>
