db2-foreign-keys.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 871b71764cdca8238069f27436d96011a6a2cb36 Maintainer: jsgoupil Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="function.db2-foreign-keys" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>db2_foreign_keys</refname>
  <refpurpose>
   Retourne un jeu de résultats listant les clés étrangères d'une table
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>db2_foreign_keys</methodname>
   <methodparam><type>resource</type><parameter>connection</parameter></methodparam>
   <methodparam><type class="union"><type>string</type><type>null</type></type><parameter>qualifier</parameter></methodparam>
   <methodparam><type class="union"><type>string</type><type>null</type></type><parameter>schema</parameter></methodparam>
   <methodparam><type>string</type><parameter>table_name</parameter></methodparam>
  </methodsynopsis>

  <para>
   Retourne un jeu de résultats listant les clés étrangères d'une table.
  </para>

 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection</parameter></term>
     <listitem>
      <para>
       Une connexion valide à une base de données IBM DB2, Cloudscape ou
       Apache Derby.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>qualifier</parameter></term>
     <listitem>
      <para>
       Un qualificatif pour les bases de données DB2 qui fonctionnent sur
       les serveurs OS/390 ou z/OS. Pour les autres bases de données, passez
       &null; ou une chaîne vide.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>schema</parameter></term>
     <listitem>
      <para> 
       Le schéma qui contient les tables. Si <parameter>schema</parameter> est
       &null;, <function>db2_foreign_keys</function> fait concorder le schéma
       pour la connexion courante.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>table_name</parameter></term>
     <listitem>
      <para>
       Le nom de la table.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne une ressource avec le jeu de résultats contenant des lignes
   décrivant les clés étrangères à la table spécifiée. Le jeu de résultats est
   composé des colonnes suivantes :
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>Nom de la colonne</entry>
       <entry>Description</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>PKTABLE_CAT</entry>
       <entry>Nom du catalogue de la table contenant la clé primaire. La
       valeur est &null; si la table n'a pas de catalogue.</entry>
      </row>
      <row>
       <entry>PKTABLE_SCHEM</entry>
       <entry>Nom du schéma de la table contenant la clé primaire.</entry>
      </row>
      <row>
       <entry>PKTABLE_NAME</entry>
       <entry>Nom de la table contenant la clé primaire.</entry>
      </row>
      <row>
       <entry>PKCOLUMN_NAME</entry>
       <entry>Nom de la colonne contenant la clé primaire.</entry>
      </row>
      <row>
       <entry>FKTABLE_CAT</entry>
       <entry>Nom du catalogue de la table contenant la clé étrangère. La
       valeur est &null; si la table n'a pas de catalogue.</entry>
      </row>
      <row>
       <entry>FKTABLE_SCHEM</entry>
       <entry>Nom du schéma de la table contenant la clé étrangère.</entry>
      </row>
      <row>
       <entry>FKTABLE_NAME</entry>
       <entry>Nom de la table contenant la clé étrangère.</entry>
      </row>
      <row>
       <entry>FKCOLUMN_NAME</entry>
       <entry>Nom de la colonne contenant la clé étrangère.</entry>
      </row>
      <row>
       <entry>KEY_SEQ</entry>
       <entry>Position commençant à 1 de la colonne dans la clé.</entry>
      </row>
      <row>
       <entry>UPDATE_RULE</entry>
       <entry>Entier représentant l'action appliquée à la clé étrangère lorsque
       une opération est de type UPDATE.</entry>
      </row>
      <row>
       <entry>DELETE_RULE</entry>
       <entry>Entier représentant l'action appliquée à la clé étrangère lorsque
       une opération est de type DELETE.</entry>
      </row>
      <row>
       <entry>FK_NAME</entry>
       <entry>Nom de la clé étrangère.</entry>
      </row>
      <row>
       <entry>PK_NAME</entry>
       <entry>Nom de la clé primaire.</entry>
      </row>
      <row>
       <entry>DEFERRABILITY</entry>
       <entry>Un entier représentant si le mode différé de la clé étrangère
       est SQL_INITIALLY_DEFERRED, SQL_INITIALLY_IMMEDIATE ou
       SQL_NOT_DEFERRABLE.</entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>db2_column_privileges</function></member>
    <member><function>db2_columns</function></member>
    <member><function>db2_primary_keys</function></member>
    <member><function>db2_procedure_columns</function></member>
    <member><function>db2_procedures</function></member>
    <member><function>db2_special_columns</function></member>
    <member><function>db2_statistics</function></member>
    <member><function>db2_table_privileges</function></member>
    <member><function>db2_tables</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
-->