doc-fr/reference/maxdb/reference.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- EN-Revision: 1.8 Maintainer: yannick Status: ready -->
<reference id="ref.maxdb">
 <title>MaxDB PHP Extension</title>
 <titleabbrev>MaxDB</titleabbrev>

 <partintro>
  <section id="maxdb.intro">
   &reftitle.intro;
   <para>
    L'extension MaxDB de &php; vous permet d'accéder aux fonctionnalités
    fournies par MaxDB 7.5.0 et suivant. Plus d'informations sur le serveur
    de base de données MaxDB peuvent être trouvées sur 
    <ulink url="&url.maxdb;">&url.maxdb;</ulink>.
   </para>
   <para>
    L'extension MaxDB est compatible avec l'extension mysqli de MySQL. 
    Il y a simplement des différences mineurs dans le comportement de
    certaines fonctions, liées au comportement des bibliothèques sous-
    jacentes.
   </para>
   <para>
    Les différences notables sont :
   </para>
   <simplelist>
    <member><function>maxdb_character_set_name</function> :
     retourn uniquement de l'ASCII ou unicode</member>
    <member><function>maxdb_disable_reads_from_master</function> :
     fonction expérimentale</member>
    <member><function>maxdb_disable_rpl_parse</function> :
     fonction expérimentale</member>
    <member><function>maxdb_dump_debug_info</function> :
     fonction expérimentale</member>
    <member><function>maxdb_embedded_connect</function> :
     fonction expérimentale</member>
    <member><function>maxdb_enable_reads_from_master</function> :
     fonction expérimentale</member>
    <member><function>maxdb_enable_rpl_parse</function> :
     fonction expérimentale</member>
    <member><function>maxdb_get_client_info</function> :
     version différente</member>
    <member><function>maxdb_get_client_version</function> :
     version différente</member>
    <member><function>maxdb_get_host_info</function> :
     retourne localhost ou le nom d'hôte</member>
    <member><function>maxdb_get_server_info</function> :
     version différente</member>
    <member><function>maxdb_get_server_version</function> :
     version différente</member>
    <member><function>maxdb_kill</function> : déconnecte la session</member>
    <member><function>maxdb_master_query</function> :
     fonction expérimentale</member>
    <member><function>maxdb_more_results</function> :
     la fonction retourne toujours &false;</member>
    <member><function>maxdb_multi_query</function> :
     ne peut pas gérer des commandes SQL multiples</member>
    <member><function>maxdb_next_result</function> :
     la fonction retourne toujours &false;</member>
    <member><function>maxdb_options</function> :
     les optoins sont différentes</member>
    <member><function>maxdb_report</function> :
     les modes de rapports sont différents</member>
    <member><function>maxdb_rpl_parse_enabled</function> :
     fonction expérimentale</member>
    <member><function>maxdb_rpl_probe</function> :
     fonction expérimentale</member>
    <member><function>maxdb_rpl_query_type</function> :
     fonction expérimentale</member>
    <member><function>maxdb_send_query</function> :
     fonction expérimentale</member>
    <member><function>maxdb_server_end</function> :
     fonction expérimentale</member>
    <member><function>maxdb_server_init</function> :
     fonction expérimentale</member>
    <member><function>maxdb_ssl_set</function> : fonction expérimentale</member>
    <member><function>maxdb_stat</function> :
     système de status différent</member>
    <member><function>maxdb_stmt_store_result</function> : sans effet</member>
    <member><function>maxdb_store_result</function> : sans effet</member>
   </simplelist>
   <para>
    La documentation sur MaxDB est disponible sur 
    <ulink url="&url.maxdb.doc;">&url.maxdb.doc;</ulink>.
   </para>
  </section>

  <section id="maxdb.requirements">
   &reftitle.required;
   <para>
    Pour pouvoir utiliser ces fonctions, vous devez compiler &php; avec le 
    support MaxDB. Additionnellement, vous devez avoir de disponible
    la bibliothèque MaxDB SQLDBC pour accéder au serveur MaxDB.
   </para>
   <para>
    La documentation sur MaxDB SQLDBC peut être trouvée sur
    <ulink url="&url.maxdb.doc;">&url.maxdb.doc;</ulink>.
   </para>
   <para>
    Téléchargez le paquet MaxDB SQLDBC sur 
    <ulink url="&url.maxdb.sdbc;">&url.maxdb.sdbc;</ulink>.

   </para>
  </section>

  &reference.maxdb.configure;

  &reference.maxdb.ini;

  <section id='maxdb.classes'>
   &reftitle.classes;

   <section id='maxdb.class.maxdb'>
    <title><classname>maxdb</classname></title>
    <para>
     Représente une connexion entre &php; et une base MaxDB.
    </para>
    <section id='maxdb.class.maxdb.constructor'>
     &reftitle.constructor;
     <itemizedlist>
      <listitem>
       <para><link linkend='function.maxdb-connect'>maxdb</link> : 
        constructeur</para>
      </listitem>
     </itemizedlist>
    </section>
    <section id='maxdb.class.maxdb.methods'>
     &reftitle.methods;
     <itemizedlist>
      <listitem>
       <para><link linkend='function.maxdb-autocommit'>autocommit</link> :
        active ou pas l'auto-archivage</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-change-user'>change_user</link> :
        change l'utilisateur de la base de données</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-character-set-name'>character_set_name</link> : 
        retourne le jeu de caractèrs par défaut de la connexion</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-close'>close</link> : 
        ferme une connexion ouverte</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-commit'>commit</link> : 
        valide la transaction courante</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-connect'>connect</link> : 
        ouvre une nouvelle connexion</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-debug'>debug</link> : 
        effectue des opérations de déboguage</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-dump-debug-info'>dump_debug_info</link> : 
        affiche des informations de déboguage</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-get-client-info'>get_client_info</link> : 
        retourne la version du client</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-get-host-info'>get_host_info</link>
        : retourne le type de connexion</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-get-server-info'>get_server_info</link> : 
        retourne les informations sur le serveur maxDB</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-get-server-version'>get_server_version</link> : 
        retourne la version du serveur</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-init'>init</link> : 
        initialise un objet maxdb</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-info'>info</link> : 
        lit les informations sur la dernière requête exécutée</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-kill'>kill</link> : 
        tente de terminer un thread MaxDB</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-multi-query'>multi_query</link> : 
        effectue une commande multiple</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-more-results'>more_results</link> :
        vérifie si d'autres résultats existent dans la commande multiple
        courante</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-next-result'>next_result</link> : 
        lit le prochain résultat de la commande multiple courante</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-options'>options</link> : 
        configure les options</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-ping'>ping</link> : 
        pingue le serveur et se reconnecte si besoin</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-prepare'>prepare</link> : 
        prépare une requête SQL</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-query'>query</link> : 
        exécute une requête</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-real-connect'>real_connect</link> : 
        ouvre une connexion au serveur MaxDB</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-real-escape-string'>escape_string</link> : 
        protège les caractères spéciaux dans une chaîne pour l'utiliser
        dans une requête, en tenant compte du jeu de caractères courant</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-rollback'>rollback</link> : 
        annule la transaction courante</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-select-db'>select_db</link> : 
        sélectionne la base de données par défaut</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-ssl-set'>ssl_set</link> : 
        configure les praamètres ssl</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-stat'>stat</link> : 
        lit le statut courant du système</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-stmt-init'>stmt_init</link> :
        initialise une commande à utiliser avec 
        <link linkend='function.maxdb-stmt-prepare'>maxdb_stmt_prepare</link></para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-store-result'>store_result</link> : 
        transfert un résultat de la dernière requête</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-use-result'>use_result</link> : 
        transfert un résultat non bufferisé de la dernière requête</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-thread-safe'>thread-safe</link> : 
        indique si la sécurité thread est active ou pas</para>
      </listitem>
     </itemizedlist>
    </section>
    <section id='maxdb.class.maxdb.properties'>
     &reftitle.properties;
     <itemizedlist>
      <listitem>
       <para><link linkend='function.maxdb-affected-rows'>affected_rows</link>
        : lit le nombre de lignes affectées par la dernière opération
        MaxDB</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-get-client-info'>client_info</link> 
        : retourne la version du client MaxDB sous forme de chaîne</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-get-client-version'>client_version</link> : 
        retourne la version du client MaxDB sous forme d'entier</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-errno'>errno</link> : 
        retourne le code d'erreur du dernier appel de fonction</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-error'>error</link> : 
        retourne le message d'erreur de la plus récente fonction</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-field-count'>field_count</link> : 
        return le nombre de colonne de la dernière requête</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-get-host-info'>host_info</link> : 
        return une chaîne représentant le type de connexion</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-info'>info</link> : 
        lit les informations sur la dernière requête exécutée</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-insert-id'>insert-id</link> : 
        retourne l'identifiant auto-généré par la dernière requête</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-get-proto-info'>protocol_version</link> : 
        retourne la version du protocole MaxDB utilisé</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-sqlstate'>sqlstate</link> : 
        retourne une chaîne représentant le code d'erreur SQLSTATE</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-thread-id'>thread_id</link> : 
        retourne l'identifiant du thread de la connexion courante</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-warning-count'>warning-count</link>
        : retourne le nombre d'alertes générées durant la dernière commande
        SQL</para>
      </listitem>

     </itemizedlist>
    </section>
   </section>

   <section id='maxdb.classes.stmt'>
    <title><classname>maxdb_stmt</classname></title>
    <para>
     Représente une commande préparée.
    </para>
    <section id='maxdb.class.stmt.methods'>
     &reftitle.methods;
     <itemizedlist>
      <listitem>
       <para><link linkend='function.maxdb-bind-param'>bind_param</link> :
        lie les variables à la commande préparée</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-bind-result'>bind_result</link> :
        lie les variables à la commande préaprée, pour stockage des résultats
       </para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-stmt-close'>close</link> :
        détruit la commande préparée</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-stmt-data-seek'>data-seek</link> :
        place le pointeur à une position arbitraire du résultat</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-execute'>execute</link> :
        exécute une commande préparée</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-fetch'>fetch</link> :
        lit les résultats de la commande préparée dans les variables liées
       </para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-stmt-free-result'>free_result</link>
        : libère les ressources de la mémoire</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-stmt-result-metadata'>result_metadata</link> :
        lit les méta-données d'un résultat de commande préparée</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-stmt-prepare'>prepare</link> :
        prépare une commande préparée</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-send-long-data'>send_long_data</link> :
        envoie les données par paquet</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-stmt-close-long-data'>close_long_data</link> :
        termine l'envoi de grandes données</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-stmt-reset'>reset</link> :
        remet à zéro une commande préparée</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-stmt-store-result'>store_result</link> :
        stocke tout le résultat d'une commande préparée</para>
      </listitem>
     </itemizedlist>
    </section>
    <section id='maxdb.class.stmt.properties'>
     &reftitle.properties;
     <itemizedlist>
      <listitem>
       <para><link linkend='function.maxdb-stmt-affected-rows'>affected_rows</link> :
        retourne le nombre de lignes affectées par la dernière commande préparée
       </para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-stmt-errno'>errno</link> :
        retourne le code d'erreur de la dernière commande préparée</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-stmt-error'>errno</link> :
        retourne le message d'erreur de la dernière commande préparée</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-stmt-param-count'>param_count</link>
        : retourne le nombre de paramètres pour une commande préparée</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-stmt-sqlstate'>sqlstate</link> :
        retourne une chaîne contenant le code d'erreur SQLSTATE</para>
      </listitem>
     </itemizedlist>
    </section>
   </section>
   
   <section id='maxdb.classes.result'>
    <title><classname>maxdb_result</classname></title>
    <para>
     Représente le jeu de résultat obtenu après exécution d'une requête.
    </para>
    <section id='maxdb.class.result.methods'>
     &reftitle.methods;
     <itemizedlist>
      <listitem>
       <para><link linkend='function.maxdb-free-result'>close</link> :
        détruit le jeu de résultat</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-data-seek'>data_seek</link> :
        déplace le pointeur de ligne</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-fetch-field'>fetch_field</link> :
        lit les informations de colonnes d'un résultat</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-fetch-fields'>fetch_fields</link> :
        lit les informations de toutes les colonnes d'un résultat</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-fetch-field-direct'>fetch_field_direct</link> :
        lit les informations sur une colonne spécifique</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-fetch-array'>fetch_array</link> :
        lit la ligne de résultat sous forme de tableau associatif, numérique
        ou les deux.</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-fetch-assoc'>fetch_assoc</link> :
        lit une ligne sous forme de tableau associatif</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-fetch-object'>fetch_object</link> :
        lit un résultat sous forme d'objet</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-fetch-row'>fetch_row</link> :
        lit un résultat sous forme de tableau énuméré</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-free-result'>close</link> :
        libère les ressources</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-field-seek'>field_seek</link> :
        place le pointeur à une position donnée</para>
      </listitem>
     </itemizedlist>
    </section>
    <section id='maxdb.class.result.properties'>
     &reftitle.properties;
     <itemizedlist>
      <listitem>
       <para><link linkend='function.maxdb-field-tell'>current_field</link> :
        retourne le pointeur courant</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-field-count'>field_count</link> :
        retourne le nombre de champs dans le résultat</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-fetch-lengths'>lengths</link> :
        retourne un tableau avec les tailles des colonnes</para>
      </listitem>
      <listitem>
       <para><link linkend='function.maxdb-num-rows'>num_rows</link> :
        retourne le nombre de ligne du résultat</para>
      </listitem>
     </itemizedlist>
    </section>
   </section>
  </section>

  &reference.maxdb.constants;


  <section id="maxdb.examples">
   &reftitle.examples;
   <para>
    Tous les exemples dans la documentation &php; de MaxDB utilise la base de 
    données de démonstration HETOLDB depuis MaxDB. Plus d'informations
    concernant cette base de données peuvent être trouvées sur 
    <ulink url="&url.maxdb.sampledb;">&url.maxdb.sampledb;</ulink>.
   </para>
   <para>
    Cet exemple simple montre comment se connecter, exécuter une requête, 
    afficher les lignes résultants et se déconnecter de la base de données
    MaxDB.
    <example>
     <title>Exemple global de l'extension MaxDB</title>
     <programlisting role="php">
      <![CDATA[
<?php
/* Connexion et sélection de la base de données */
$link = maxdb_connect("maxdb_host", "maxdb_user", "maxdb_password")
or die("Connexion impossible : " . maxdb_connect_error());
echo "Connexion avec succès";
maxdb_select_db("my_database") or die("Impossible de sélectionner la base de données");

/* Exécution d'une requête SQL */
$query = "SELECT * FROM my_table";
$result = maxdb_query($link, $query) or die("Query failed : " . maxdb_error());

/* Affichage des résultats en HTML */
echo "<table>\n";
while ($line = maxdb_fetch_array($result, MAXDB_ASSOC)) {
   echo "\t<tr>\n";
   foreach ($line as $col_value) {
      echo "\t\t<td>$col_value</td>\n";
   }
   echo "\t</tr>\n";
}
echo "</table>\n";

/* Libération des ressources */
maxdb_free_result($result);

/* Fermeture de la connexion */
maxdb_close($link);
?>
]]>
     </programlisting>
    </example>
   </para>
  </section>
 </partintro>

 &reference.maxdb.functions;

</reference>

<!-- 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:"../../../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
-->