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

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

<refentry xml:id="function.db2-columns" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>db2_columns</refname>
  <refpurpose>
   Retourne un jeu de résultats listant les colonnes et ses métadonnées d'une table
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>db2_columns</methodname>
   <methodparam><type>resource</type><parameter>connection</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>qualifier</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>schema</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>table-name</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>column-name</parameter></methodparam>
  </methodsynopsis>

  <para>
   Retourne un jeu de résultats listant les colonnes et ses métadonnées 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. Pour concorder avec tous les
       schémas, passez <literal>'%'</literal>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>table-name</parameter></term>
     <listitem>
      <para>
       Le nom de la table. Pour obtenir toutes les tables dans la base de
       données, passez &null; ou une chaîne vide.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>column-name</parameter></term>
     <listitem>
      <para>
       Le nom de la colonne. Pour obtenir toutes les colonnes de la table,
       passez &null; ou une chaîne vide.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne une ressource avec le jeu de résultats contenant les lignes qui
   décrivent les privilèges des colonnes concordant avec les paramètres
   spécifiés. 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>TABLE_CAT</entry>
       <entry>Nom du catalogue. La valeur est &null; si la table ne possède
       pas de catalogue.</entry>
      </row>
      <row>
       <entry>TABLE_SCHEM</entry>
       <entry>Nom du schéma.</entry>
      </row>
      <row>
       <entry>TABLE_NAME</entry>
       <entry>Nom de la table.</entry>
      </row>
      <row>
       <entry>COLUMN_NAME</entry>
       <entry>Nom de la colonne.</entry>
      </row>
      <row>
       <entry>DATA_TYPE</entry>
       <entry>Le type de données SQL pour la colonne, représenté comme un
       entier.</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>NULLABLE</entry>
       <entry>Un entier représentant si la colonne peut être nulle ou pas.</entry>
      </row>
      <row>
       <entry>REMARKS</entry>
       <entry>Description de la colonne.</entry>
      </row>
      <row>
       <entry>COLUMN_DEF</entry>
       <entry>Valeur par défaut de la colonne.</entry>
      </row>
      <row>
       <entry>SQL_DATA_TYPE</entry>
       <entry>Un entier représentant la grandeur de la colonne.</entry>
      </row>
      <row>
       <entry>SQL_DATETIME_SUB</entry>
       <entry>Retourne un entier représentant un code de sous-type 
       <literal>datetime</literal> ou
       &null; si les types de données SQL n'appliquent pas.</entry>
      </row>
      <row>
       <entry>CHAR_OCTET_LENGTH</entry>
       <entry>Grandeur maximale en octets pour les types de données d'un
       caractère de la colonne, qui concorde avec COLUMN_SIZE pour un seul
       octet de données ou &null; pour un type de données qui n'est pas des
       caractères.</entry>
      </row>
      <row>
       <entry>ORDINAL_POSITION</entry>
       <entry>La position de la colonne commençant à 1 dans la table.</entry>
      </row>
      <row>
       <entry>IS_NULLABLE</entry>
       <entry>Une chaîne dont la valeur est 'YES' signifie que la colonne est
       nulle et 'NO' signifie que la colonne ne peut être nulle.</entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>db2_column_privileges</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_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
-->