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

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

<refentry xml:id="function.db2-statistics" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>db2_statistics</refname>
  <refpurpose>
   Retourne un jeu de résultats listant les index et statistiques d'une table
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>db2_statistics</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>bool</type><parameter>unique</parameter></methodparam>
  </methodsynopsis>

  <para>
   Retourne un jeu de résultats listant les index et statistiques 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 visées. Si le paramètre est &null;,
       les statistiques et les index sont retournés pour le schéma de
       l'utilisateur en cours.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>table_name</parameter></term>
     <listitem>
      <para>
       Le nom de la table.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>unique</parameter></term>
     <listitem>
      <para>
       Un entier représentant le type d'information à retourner.
       <variablelist>
        <varlistentry>
         <term><parameter>0</parameter></term>
         <listitem>
          <para>
           Retourne seulement les informations pour les index uniques de la
           table.
          </para>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>1</parameter></term>
         <listitem>
          <para>
           Retourne les informations pour tous les index de la table.
          </para>
         </listitem>
        </varlistentry>
       </variablelist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Ce que la fonction retourne, premièrement lors de succès, ensuite lors
   d'échec. Voyez aussi l'entité &return.success;
   <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 que contient la table.
       La valeur est &null; si la table n'a pas de catalogue.</entry>
      </row>
      <row>
       <entry>TABLE_SCHEM</entry>
       <entry>Nom du schéma que contient la table.</entry>
      </row>
      <row>
       <entry>TABLE_NAME</entry>
       <entry>Nom de la table.</entry>
      </row>
      <row>
       <entry>NON_UNIQUE</entry>
       <entry>
        <para>
         Un entier représentant si l'index interdit les valeurs uniques ou si
         la ligne représente des statistiques sur la table elle-même :
         <informaltable>
          <tgroup cols="2">
           <thead>
            <row>
             <entry>Valeur de retour</entry>
             <entry>Type de paramètre</entry>
            </row>
           </thead>
           <tbody>
            <row>
             <entry>0 (SQL_FALSE)</entry>
             <entry>L'index autorise les valeurs dupliquées.</entry>
            </row>
            <row>
             <entry>1 (SQL_TRUE)</entry>
             <entry>Les valeurs index doivent être uniques.</entry>
            </row>
            <row>
             <entry>&null;</entry>
             <entry>La ligne contient des informations statistiques à propos de la table.</entry>
            </row>
           </tbody>
          </tgroup>
         </informaltable>
        </para>
       </entry>
      </row>
      <row>
       <entry>INDEX_QUALIFIER</entry>
       <entry>Une chaîne de caractères représentant un qualificatif qui devrait
       avoir été préalablement fixé à INDEX_NAME pour qualifier complètement
       l'index.</entry>
      </row>
      <row>
       <entry>INDEX_NAME</entry>
       <entry>Une chaîne représentant le nom de l'index.</entry>
      </row>
      <row>
       <entry>TYPE</entry>
       <entry>
        <para>
         Un entier représentant le type d'informations contenues dans cette
         ligne du jeu de résultats :
         <informaltable>
          <tgroup cols="2">
           <thead>
            <row>
             <entry>Valeur de retour</entry>
             <entry>Type de paramètre</entry>
            </row>
           </thead>
           <tbody>
            <row>
             <entry>0 (SQL_TABLE_STAT)</entry>
             <entry>La ligne contient des informations statistiques à propos de la table.</entry>
            </row>
            <row>
             <entry>1 (SQL_INDEX_CLUSTERED)</entry>
             <entry>La ligne contient des informations à propos d'index groupé.</entry>
            </row>
            <row>
             <entry>2 (SQL_INDEX_HASH)</entry>
             <entry>La ligne contient des informations à propos d'index haché.</entry>
            </row>
            <row>
             <entry>3 (SQL_INDEX_OTHER)</entry>
             <entry>La ligne contient des informations à propos du type
             d'index qui n'est pas groupé ni haché.</entry>
            </row>
           </tbody>
          </tgroup>
         </informaltable>
        </para>
       </entry>
      </row>
      <row>
       <entry>ORDINAL_POSITION</entry>
       <entry>Un tableau commençant à l'index 1 indiquant la colonne dans
       l'index. &null; si la ligne contient des informations statistiques à
       propos de la table.</entry>
      </row>
      <row>
       <entry>COLUMN_NAME</entry>
       <entry>Le nom de la colonne dans l'index. &null; si la ligne contient
       des informations statistiques à propos de la table.</entry>
      </row>
      <row>
       <entry>ASC_OR_DESC</entry>
       <entry>
        <literal>A</literal> si la colonne est triée en ordre alphabétique,
        <literal>D</literal> si la colonne est triée en ordre alphabétique
        inverse, &null; si la ligne contient des informations statistiques à
        propos de la table.
       </entry>
      </row>
      <row>
       <entry>CARDINALITY</entry>
       <entry>
        <para>
         Si la ligne contient des informations à propos d'un index, cette
         colonne contiendra un entier représentant le nombre de valeurs uniques
         dans l'index.
        </para>
        <para>
         Si la ligne contient des informations à propos de la table, cette
         colonne contiendra un entier représentant le nombre de lignes dans la
         table.
        </para>
       </entry>
      </row>
      <row>
       <entry>PAGES</entry>
       <entry>
        <para>
         Si la ligne contient des informations à propos d'un index, cette
         colonne contiendra un entier représentant le nombre de pages
         utilisées pour enregistrer l'index.
        </para>
        <para>
         Si la ligne contient des informations à propos de la table, cette
         colonne contiendra un entier représentant le nombre de pages utilisées
         pour enregistrer la table.
        </para>
       </entry>
      </row>
      <row>
       <entry>FILTER_CONDITION</entry>
       <entry>Retourne toujours &null;.</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_special_columns</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
-->