<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = 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 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'function.odbc-foreignkeys.php',
    1 => 'odbc_foreignkeys',
    2 => 'Recupera uma lista de chaves estrangeiras',
  ),
  'up' => 
  array (
    0 => 'ref.uodbc.php',
    1 => 'Fun&ccedil;&otilde;es de ODBC',
  ),
  'prev' => 
  array (
    0 => 'function.odbc-field-type.php',
    1 => 'odbc_field_type',
  ),
  'next' => 
  array (
    0 => 'function.odbc-free-result.php',
    1 => 'odbc_free_result',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/uodbc/functions/odbc-foreignkeys.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.odbc-foreignkeys" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">odbc_foreignkeys</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">odbc_foreignkeys</span> &mdash; <span class="dc-title">Recupera uma lista de chaves estrangeiras</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.odbc-foreignkeys-description">
  <h3 class="title">Descrição</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>odbc_foreignkeys</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type">Odbc\Connection</span> <code class="parameter">$odbc</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$pk_catalog</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$pk_schema</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$pk_table</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$fk_catalog</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$fk_schema</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$fk_table</code></span><br>): <span class="type"><span class="type">Odbc\Result</span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   Recupera uma lista de chaves estrangeiras na tabela especificada ou uma lista de
   chaves estrangeiras em outras tabelas que se referem à chave primária na
   tabela especificada.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.odbc-foreignkeys-parameters">
  <h3 class="title">Parâmetros</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">odbc</code></dt>
     <dd>
      <p class="para">O objeto da conexão ODBC.
Consulte <span class="function"><a href="function.odbc-connect.php" class="function">odbc_connect()</a></span> para obter detalhes.</p>
     </dd>
    
    
     <dt><code class="parameter">pk_catalog</code></dt>
     <dd>
      <p class="para">
       O catálogo (&#039;qualifier&#039; na linguagem ODBC 2) da tabela da chave primária.
      </p>
     </dd>
    
    
     <dt><code class="parameter">pk_schema</code></dt>
     <dd>
      <p class="para">
       O esquema (&#039;owner&#039; no jargão do ODBC 2) da tabela da chave primária.
      </p>
     </dd>
    
    
     <dt><code class="parameter">pk_table</code></dt>
     <dd>
      <p class="para">
       A tabela de chave primária.
      </p>
     </dd>
    
    
     <dt><code class="parameter">fk_catalog</code></dt>
     <dd>
      <p class="para">
       O catálogo (&#039;qualifier&#039; na linguagem ODBC 2) da tabela da chave estrangeira.
      </p>
     </dd>
    
    
     <dt><code class="parameter">fk_schema</code></dt>
     <dd>
      <p class="para">
       O esquema (&#039;owner&#039; no jargão do ODBC 2) da tabela da chave estrangeira.
      </p>
     </dd>
    
    
     <dt><code class="parameter">fk_table</code></dt>
     <dd>
      <p class="para">
       A tabela da chave estrangeira.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.odbc-foreignkeys-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="para">
   Retorna um objeto de resultado ODBC ou <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> em caso de falha.
  </p>
  <p class="para">
   O conjunto de resultados possui as seguintes colunas:
   <ul class="itemizedlist">
    <li class="listitem"><span class="simpara"><code class="literal">PKTABLE_CAT</code></span></li>
    <li class="listitem"><span class="simpara"><code class="literal">PKTABLE_SCHEM</code></span></li>
    <li class="listitem"><span class="simpara"><code class="literal">PKTABLE_NAME</code></span></li>
    <li class="listitem"><span class="simpara"><code class="literal">PKCOLUMN_NAME</code></span></li>
    <li class="listitem"><span class="simpara"><code class="literal">FKTABLE_CAT</code></span></li>
    <li class="listitem"><span class="simpara"><code class="literal">FKTABLE_SCHEM</code></span></li>
    <li class="listitem"><span class="simpara"><code class="literal">FKTABLE_NAME</code></span></li>
    <li class="listitem"><span class="simpara"><code class="literal">FKCOLUMN_NAME</code></span></li>
    <li class="listitem"><span class="simpara"><code class="literal">KEY_SEQ</code></span></li>
    <li class="listitem"><span class="simpara"><code class="literal">UPDATE_RULE</code></span></li>
    <li class="listitem"><span class="simpara"><code class="literal">DELETE_RULE</code></span></li>
    <li class="listitem"><span class="simpara"><code class="literal">FK_NAME</code></span></li>
    <li class="listitem"><span class="simpara"><code class="literal">PK_NAME</code></span></li>
    <li class="listitem"><span class="simpara"><code class="literal">DEFERRABILITY</code></span></li>
   </ul>
   Drivers podem listar colunas adicionais.
  </p>
  <p class="simpara">
   Se as chaves estrangeiras associadas a uma chave primária forem solicitadas, o conjunto de resultados
   será ordenado por <code class="literal">FKTABLE_CAT</code>, <code class="literal">FKTABLE_SCHEM</code>,
   <code class="literal">FKTABLE_NAME</code> e <code class="literal">KEY_SEQ</code>.
   Se as chaves primárias associadas a uma chave estrangeira forem solicitadas, o conjunto de resultados
   será ordenado por <code class="literal">PKTABLE_CAT</code>, <code class="literal">PKTABLE_SCHEM</code>,
   <code class="literal">PKTABLE_NAME</code> e <code class="literal">KEY_SEQ</code>.
  </p>
  <p class="simpara">
   Se <code class="parameter">pk_table</code> contiver um nome de tabela,
   <span class="function"><strong>odbc_foreignkeys()</strong></span> retornará um conjunto de resultados
   contendo a chave primária da tabela especificada e todas as
   chaves estrangeiras que se referem a ela.
  </p>
  <p class="simpara">
   Se <code class="parameter">fk_table</code> contiver um nome de tabela,
   <span class="function"><strong>odbc_foreignkeys()</strong></span> retornará um conjunto de resultados
   contendo todas as chaves estrangeiras na tabela especificada e as
   chaves primárias (em outras tabelas) às quais elas se referem.
  </p>
  <p class="simpara">
   Se ambos <code class="parameter">pk_table</code> e
   <code class="parameter">fk_table</code> contiverem nomes de tabelas,
   <span class="function"><strong>odbc_foreignkeys()</strong></span> retornará as chaves estrangeiras na
   tabela especificada em <code class="parameter">fk_table</code> que se referem
   à chave primária da tabela especificada em
   <code class="parameter">pk_table</code>. Esta deve ser uma chave no máximo.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.odbc-foreignkeys-changelog">
  <h3 class="title">Registro de Alterações</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>Versão</th>
      <th>Descrição</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
 <td>8.4.0</td>
 <td>
  <code class="parameter">odbc</code> agora espera uma instância de <span class="classname"><strong class="classname">Odbc\Connection</strong></span>;
  anteriormente, esperava um <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span>.
 </td>
</tr>

     <tr>
 <td>8.4.0</td>
 <td>
  Esta função agora retorna uma instância de <span class="classname"><strong class="classname">Odbc\Result</strong></span>;
  anteriormente, retornava um <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span>.
 </td>
</tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 seealso" id="refsect1-function.odbc-foreignkeys-seealso">
  <h3 class="title">Veja Também</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.odbc-tables.php" class="function" rel="rdfs-seeAlso">odbc_tables()</a> - Obt&eacute;m a lista de nomes de tabelas armazenadas em uma fonte de dados espec&iacute;fica</span></li>
    <li><span class="function"><a href="function.odbc-primarykeys.php" class="function" rel="rdfs-seeAlso">odbc_primarykeys()</a> - Obt&eacute;m as chaves prim&aacute;rias de uma tabela</span></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>