odbc-foreignkeys.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: ed1aff13602c94f86344bdd7c4fbc31f5a71bf84 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.odbc-foreignkeys" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>odbc_foreignkeys</refname>
  <refpurpose>Lista las claves foráneas</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>Odbc\Result</type><type>false</type></type><methodname>odbc_foreignkeys</methodname>
   <methodparam><type>Odbc\Connection</type><parameter>odbc</parameter></methodparam>
   <methodparam><type class="union"><type>string</type><type>null</type></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_catalog</parameter></methodparam>
   <methodparam><type>string</type><parameter>fk_schema</parameter></methodparam>
   <methodparam><type>string</type><parameter>fk_table</parameter></methodparam>
  </methodsynopsis>
  <para>
   Devuelve una lista de claves foráneas en la tabla especificada o una lista de
   claves foráneas en otras tablas que hacen referencia a la clave primaria en la
   tabla especificada.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>odbc</parameter></term>
     <listitem>
      &odbc.connection.id;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>fk_catalog</parameter></term>
     <listitem>
      <para>
       El catálogo (&apos;qualifier&apos; en terminología ODBC 2) de la clave
       primaria de la tabla.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>pk_schema</parameter></term>
     <listitem>
      <para>
       El esquema (&apos;qualifier&apos; en terminología ODBC 2) de la clave
       primaria de la tabla.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>pk_table</parameter></term>
     <listitem>
      <para>
       La tabla de clave primaria.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>pk_catalog</parameter></term>
     <listitem>
      <para>
       El catálogo (&apos;qualifier&apos; en terminología ODBC 2) de la clave
       foránea de la tabla.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>fk_schema</parameter></term>
     <listitem>
      <para>
       El esquema (&apos;qualifier&apos; en terminología ODBC 2) de la clave
       foránea de la tabla.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>fk_table</parameter></term>
     <listitem>
      <para>
       La tabla de clave foránea.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &odbc.result.object-return-falseforfailure;
  </para>
  <para>
   El conjunto de resultados contiene las siguientes columnas:
   <itemizedlist>
    <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>
   Si las claves foráneas asociadas con una clave primaria son solicitadas, el conjunto
   de resultados está ordenado por <literal>FKTABLE_CAT</literal>, <literal>FKTABLE_SCHEM</literal>,
   <literal>FKTABLE_NAME</literal> y <literal>KEY_SEQ</literal>.
   Si las claves primarias asociadas con una clave foránea son solicitadas, el conjunto
   de resultados está ordenado por <literal>PKTABLE_CAT</literal>, <literal>PKTABLE_SCHEM</literal>,
   <literal>PKTABLE_NAME</literal> y <literal>KEY_SEQ</literal>.
  </simpara>
  <simpara>
   Si <parameter>pk_table</parameter> contiene un nombre de tabla,
   <function>odbc_foreignkeys</function> retorna la clave primaria
   de la tabla <parameter>pk_table</parameter>, y todas las
   claves foráneas que hacen referencia a ella.
  </simpara>
  <simpara>
   Si <parameter>fk_table</parameter> contiene un nombre de tabla,
   <function>odbc_foreignkeys</function> retorna la lista de
   claves foráneas de la tabla <parameter>fk_table</parameter>,
   y las claves primarias (de otras tablas) que hacen referencia a ella.
  </simpara>
  <simpara>
   Si <parameter>pk_table</parameter> y
   <parameter>fk_table</parameter> contienen nombres de tablas,
   <function>odbc_foreignkeys</function> retorna la lista de claves
   foráneas de la tabla <parameter>fk_table</parameter> que utilizan
   la clave primaria de la tabla <parameter>pk_table</parameter>.
   Esta lista debería contener como máximo una clave.
  </simpara>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &odbc.changelog.connection-param;
     &odbc.changelog.result-return;
    </tbody>
   </tgroup>
  </informaltable>
 </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
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
-->