doc-fr/reference/ibm_db2/functions/db2-special-columns.xml

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

<refentry xml:id="function.db2-special-columns" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>db2_special_columns</refname>
  <refpurpose>
   Retourne un jeu de résultats listant les identifiants uniques des lignes d'une table
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>db2_special_columns</methodname>
   <methodparam><type>resource</type><parameter>connection</parameter></methodparam>
   <methodparam><type>string</type><parameter>qualifier</parameter></methodparam>
   <methodparam><type>string</type><parameter>schema</parameter></methodparam>
   <methodparam><type>string</type><parameter>table_name</parameter></methodparam>
   <methodparam><type>int</type><parameter>scope</parameter></methodparam>
  </methodsynopsis>

  <para>
   Retourne un jeu de résultats listant les identifiants uniques des lignes
   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.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>table_name</parameter></term>
     <listitem>
      <para>
       Le nom de la table.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>scope</parameter></term>
     <listitem>
      <para>
       Un entier représentant le temps minimal pour lequel l'identifiant
       unique de la ligne est valide. Cela peut être une des valeurs suivantes :
       <informaltable>
        <tgroup cols="3">
         <thead>
          <row>
           <entry>Valeur Entier</entry>
           <entry>Constante SQL</entry>
           <entry>Description</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry>0</entry>
           <entry>SQL_SCOPE_CURROW</entry>
           <entry>L'identifiant de la ligne est valide seulement lorsque
           curseur est positionné sur la ligne.</entry>
          </row>
          <row>
           <entry>1</entry>
           <entry>SQL_SCOPE_TRANSACTION</entry>
           <entry>L'identifiant de la ligne est valide pour la durée de la
           transaction.</entry>
          </row>
          <row>
           <entry>2</entry>
           <entry>SQL_SCOPE_SESSION</entry>
           <entry>L'identifiant de la ligne est valide durant la durée de la
           connexion.</entry>
          </row>
         </tbody>
        </tgroup>
       </informaltable>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne une ressource avec un jeu de résultats contenant des lignes avec
   des informations uniques pour une table. Les lignes sont composées des
   colonnes suivantes :
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>Nom de la colonne</entry>
       <entry>Description</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>SCOPE</entry>
       <entry>
        <para>
         <informaltable>
          <tgroup cols="3">
           <thead>
            <row>
             <entry>Valeur Entier</entry>
             <entry>Constante SQL</entry>
             <entry>Description</entry>
            </row>
           </thead>
           <tbody>
            <row>
             <entry>0</entry>
             <entry>SQL_SCOPE_CURROW</entry>
             <entry>L'identifiant de la ligne est valide seulement lorsque
             curseur est positionné sur la ligne.</entry>
            </row>
            <row>
             <entry>1</entry>
             <entry>SQL_SCOPE_TRANSACTION</entry>
             <entry>L'identifiant de la ligne est valide pour la durée de la
             transaction.</entry>
            </row>
            <row>
             <entry>2</entry>
             <entry>SQL_SCOPE_SESSION</entry>
             <entry>L'identifiant de la ligne est valide durant la durée de la
             connexion.</entry>
            </row>
           </tbody>
          </tgroup>
         </informaltable>
        </para>
       </entry>
      </row>
      <row>
       <entry>COLUMN_NAME</entry>
       <entry>Nom de la colonne unique.</entry>
      </row>
      <row>
       <entry>DATA_TYPE</entry>
       <entry>Le type de données SQL pour la colonne.</entry>
      </row>
      <row>
       <entry>TYPE_NAME</entry>
       <entry>Une chaîne représentant le type de données pour la
       colonne.</entry>
      </row>
      <row>
       <entry>COLUMN_SIZE</entry>
       <entry>Un entier représentant la grandeur de la colonne.</entry>
      </row>
      <row>
       <entry>BUFFER_LENGTH</entry>
       <entry>Nombre d'octets maximaux nécessaires pour enregistrer des
       données de cette colonne.</entry>
      </row>
      <row>
       <entry>DECIMAL_DIGITS</entry>
       <entry>L'échelle de la colonne ou &null; où l'échelle n'est pas
       applicable.</entry>
      </row>
      <row>
       <entry>NUM_PREC_RADIX</entry>
       <entry>Un entier pouvant être <literal>10</literal> (représentant un
       type de données numérique exact), <literal>2</literal> (représentant un
       type de données numériques approximé) ou &null; (représentant un type
       de données pour lequel la base n'est pas applicable).</entry>
      </row>
      <row>
       <entry>PSEUDO_COLUMN</entry>
       <entry>Retourne toujours 1.</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_foreign_keys</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_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
-->