cvs: phpdoc /fr/functions uodbc.xml

From:	Damien Seguy	Date:	Thu, 23 Nov 2000 14:26:15 +0000
Subject:	cvs: phpdoc /fr/functions uodbc.xml
Groups:	php.doc
Request:	Send a blank email to phpdoc+get-969333046@lists.php.net to get a copy of this message

dams Thu Nov 23 06:26:15 2000 EDT Modified files: /phpdoc/fr/functions uodbc.xml Log: Added all thoses listing functions.

Index: phpdoc/fr/functions/uodbc.xml diff -u phpdoc/fr/functions/uodbc.xml:1.1 phpdoc/fr/functions/uodbc.xml:1.2 --- phpdoc/fr/functions/uodbc.xml:1.1 Fri Jul 21 03:27:50 2000 +++ phpdoc/fr/functions/uodbc.xml Thu Nov 23 06:26:15 2000 @@ -1,857 +1,1610 @@ - <reference id="ref.odbc"> - <title>ODBC</title> - <titleabbrev>ODBC</titleabbrev> - - <refentry id="function.odbc-autocommit"> - <refnamediv> - <refname>odbc_autocommit</refname> - <refpurpose>Mode auto-validation</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>odbc_autocommit</function></funcdef> - <paramdef>int <parameter>connection_id</parameter></paramdef> - <paramdef>int <parameter><optional>OnOff</optional></parameter></paramdef> - </funcsynopsis> - <para> - Sans paramètre <parameter>OnOff</parameter>, cette fonction retourne le statut - d'auto-validation de la connexion <parameter>connection_id</parameter>. - TRUE si le mode est activé, FALSE si il ne l'est pas, ou si une erreur survient. - </para> - <para> - Si <parameter>OnOff</parameter> vaut TRUE, l'auto-validation est activée. Si - il est FALSE, l'auto-validation est desactivée. Retourne TRUE en cas de succès, - FALSE en cas d'échec. - </para> - <para> - Par défaut, l'auto-validation est activée. Désactiver l'auto-validation est - équivalent à démarrer une transaction. - </para> - <simpara> - Voir aussi - <function>odbc_commit</function> et <function>odbc_rollback</function>. - </simpara> - </refsect1> - </refentry> - - <refentry id="function.odbc-binmode"> - <refnamediv> - <refname>odbc_binmode</refname> - <refpurpose>Gestion des colonnes de données binaires.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>odbc_binmode</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> - </funcsynopsis> - <para> - Types ODBC SQL affectés: BINARY, VARBINARY, LONGVARBINARY. - </para> - <itemizedlist> - <listitem><simpara> - ODBC_BINMODE_PASSTHRU: Mode Passthru - </simpara></listitem> - <listitem><simpara> - ODBC_BINMODE_RETURN: Retourne tel quel. - </simpara></listitem> - <listitem><simpara> - ODBC_BINMODE_CONVERT: Converti en char et retourne la valeur. - </simpara></listitem> - </itemizedlist> - <para> - Lorsqu'une donnée SQL est convertie en caractère C, les 8 bits du caractère source - sont représentés par deux caractères ASCII. Ces caractères sont des représentations - ASCII des nombres au format hexadécimal. Par exemple, le binaire 00000001 est - converti en <literal>"01"</literal> et le binaire 11111111 est converti en - <literal>"FF"</literal>. - <table> - <title>Conversion des LONGVARBINARY </title> - <tgroup cols="3"> - <thead> - <row> - <entry>mode</entry> - <entry>longueur</entry> - <entry>résultat</entry> - </row> - </thead> - <tbody> - <row> - <entry>ODBC_BINMODE_PASSTHRU</entry> - <entry>0</entry> - <entry>passthru</entry> - </row> - <row> - <entry>ODBC_BINMODE_RETURN</entry> - <entry>0</entry> - <entry>passthru</entry> - </row> - <row> - <entry>ODBC_BINMODE_CONVERT</entry> - <entry>0</entry> - <entry>passthru</entry> - </row> - <row> - <entry>ODBC_BINMODE_PASSTHRU</entry> - <entry>0</entry> - <entry>passthru</entry> - </row> - <row> - <entry>ODBC_BINMODE_PASSTHRU</entry> - <entry>>0</entry> - <entry>passthru</entry> - </row> - <row> - <entry>ODBC_BINMODE_RETURN</entry> - <entry>>0</entry> - <entry>Tel quel</entry> - </row> - <row> - <entry>ODBC_BINMODE_CONVERT</entry> - <entry>>0</entry> - <entry>Caractère</entry> - </row> - </tbody> - </tgroup> - </table></para> - - <para> - Si <function>odbc_fetch_into</function> est utilisé, passthru signifie qu'une - chaîne vide sera retournée pour ces colonnes. - </para> - - <para> - Si <parameter>result_id</parameter> vaut <literal>0</literal>, ces paramètres - seront appliqués aux nouveaux résultats. - - <note> - <simpara> - La valeur par défaut de <literal>4096</literal> est 4096 et les valeurs par - défaut de odbc_binmode est <literal>ODBC_BINMODE_RETURN</literal>. - La gestion des colonnes binaires est aussi modifié par - <function>odbc_longreadlen</function>. - </simpara> - </note> - </para> - </refsect1> - </refentry> - - <refentry id="function.odbc-close"> - <refnamediv> - <refname>odbc_close</refname> - <refpurpose>Ferme une connexion ODBC.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>void <function>odbc_close</function></funcdef> - <paramdef>int <parameter>connection_id</parameter></paramdef> - </funcsynopsis> - - <para> - <function>odbc_close</function> ferme la connexion avec une source de données, - représentée par l'identifiant de connexion. - - <note><simpara> - Cette fonction échouera si il y a des transactions en cours sur cette connexion. - Dans ce cas, la connexion restera ouverte. - </simpara></note></para> - - </refsect1> - </refentry> - - <refentry id="function.odbc-close-all"> - <refnamediv> - <refname>odbc_close_all</refname> - <refpurpose>Ferme toutes les connexions ODBC</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>void <function>odbc_close_all</function></funcdef> - <void/> - </funcsynopsis> - - <para> - <function>odbc_close_all</function> ferme toutes les connexions ODBC à des - sources de données. - - <note><simpara> - Cette fonction échouera si il y a des transactions en cours sur cette connexion. - Dans ce cas, la connexion restera ouverte. - </simpara></note></para> - - </refsect1> - </refentry> - - <refentry id="function.odbc-commit"> - <refnamediv> - <refname>odbc_commit</refname> - <refpurpose>Valide une transaction ODBC </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>odbc_commit</function></funcdef> - <paramdef>int <parameter>connection_id</parameter></paramdef> - </funcsynopsis> - <para> - Retourne: TRUE en case de succès, FALSE en cas d'erreur. Toutes les connexions en - cours sur <parameter>connection_id</parameter> sont validées. - - Toutes les connexions en cours sur <parameter>connection_id</parameter> sont - validées. - </para> - </refsect1> - </refentry> - - - <refentry id="function.odbc-connect"> - <refnamediv> - <refname>odbc_connect</refname> - <refpurpose>Connexion à une source</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>odbc_connect</function></funcdef> - <paramdef>string <parameter>dsn</parameter></paramdef> - <paramdef>string <parameter>user</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - <paramdef>int <parameter><optional>cursor_type</optional></parameter></paramdef> - </funcsynopsis> - <para> - Retourne un identifiant de connexion ODBC ou 0 (FALSE) en cas d'erreur. - </para> - <simpara> - L'identifiant de connexion retournée par cette fonction est nécessaire pour - toutes les autres fonctions ODBC. Vous pouvez avoir de multiples connexions - en même temps. Le quatrième paramètre fixe le type de pointeur de résultat - utilisé pour cette connexion. Ce paramètre n'est généralement pas nécessaire, - mais il peut être utile pour contourner certains problèmes ODBC. - </simpara> - <simpara> - Avec certains pilotes ODBC, l'exécution de procédures enregistrées complexes - peut produire l'erreur suivante : "Cannot open a cursor on a stored procedure - that has anything other than a single select statement in it", ce qui signifie : - "Impossible de créer un pointeur de résultat dans une procédure enregistrée qui - est réduite à une simple selection (SELECT)). Utiliser l'option SQL_CUR_USE_ODBC - permet d'éviter cette erreur. De plus, certains pilotes ne supportent le paramètre - optionnel de numéro de ligne dans <function>odbc_fetch_row</function>. - SQL_CUR_USE_ODBC peut aussi permettre de résoudre ces problèmes. - </simpara> - <simpara> - Les constantes suivantes sont définies comme type de pointeur : - </simpara> - <para> - <itemizedlist> - <listitem><simpara> - SQL_CUR_USE_IF_NEEDED - </simpara></listitem> - <listitem><simpara> - SQL_CUR_USE_ODBC - </simpara></listitem> - <listitem><simpara> - SQL_CUR_USE_DRIVER - </simpara></listitem> - <listitem><simpara> - SQL_CUR_DEFAULT - </simpara></listitem> - </itemizedlist></para> - <simpara> - Pour les connexions persistantes, reportez vous à - <function>odbc_pconnect</function>. - </simpara> - </refsect1> - </refentry> - - <refentry id="function.odbc-cursor"> - <refnamediv> - <refname>odbc_cursor</refname> - <refpurpose>Lecture du pointeur de fiche courante (cursorname).</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>string <function>odbc_cursor</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - </funcsynopsis> - <para> - <function>odbc_cursor</function> lit le pointeur de fiche courante - (cursorname) pour le résultat <parameter>result_id</parameter>. - </para> - </refsect1> - </refentry> - - <refentry id="function.odbc-do"> - <refnamediv> - <refname>odbc_do</refname> - <refpurpose>Synonyme de <function>odbc_exec</function></refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>string <function>odbc_do</function></funcdef> - <paramdef>int <parameter>conn_id</parameter></paramdef> - <paramdef>string <parameter>query</parameter></paramdef> - </funcsynopsis> - <para> - <function>odbc_do</function> excécute la requête <parameter>query</parameter> - avec la connexion <parameter>conn_id</parameter>. - </para> - </refsect1> - </refentry> - - - <refentry id="function.odbc-exec"> - <refnamediv> - <refname>odbc_exec</refname> - <refpurpose>Prépare et exécute une requête SQL.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>odbc_exec</function></funcdef> - <paramdef>int <parameter>connection_id</parameter></paramdef> - <paramdef>string <parameter>query_string</parameter></paramdef> - </funcsynopsis> - <para> - Retourne FALSE en cas d'erreur. Retourne un identifiant de résultat ODBC en cas - d'exécution réussie. - </para> - <para> - <function>odbc_exec</function> envoie une commande SQL à la source de données - représentée par <parameter>connection_id</parameter>. Ce paramètre doit être un - identifiant valide de connexion, retourné par <function>odbc_connect</function> ou - <function>odbc_pconnect</function>. - </para> - <simpara> - Voir aussi : <function>odbc_prepare</function> et <function>odbc_execute</function> - pour les éxecutions multiples de requêtes SQL. - </simpara> - </refsect1> - </refentry> - -<refentry id="function.odbc-execute"> - <refnamediv> - <refname>odbc_execute</refname> - <refpurpose>Exécute une requête SQL préparée.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>odbc_execute</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>array - <parameter><optional>parameters_array</optional></parameter></paramdef> - </funcsynopsis> - <para> - Exécute une requête SQL préparée par <function>odbc_prepare</function>. - Retourne TRUE en cas d'exécution réussie, et FALSE sinon. Le tableau de paramètres - <parameter>parameters_array</parameter> ne sert que si vous avez besoin de - paramètres votre requête. - </para> - </refsect1> -</refentry> - - - <refentry id="function.odbc-fetch-into"> - <refnamediv> - <refname>odbc_fetch_into</refname> - <refpurpose>Lit une ligne de résultat, et la place dans un tableau.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>odbc_fetch_into</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>int <parameter><optional>rownumber</optional></parameter></paramdef> - <paramdef>array <parameter>result_array</parameter></paramdef> - </funcsynopsis> - <para> - Retourne le nombre de colonnes dans le résultat, ou FALSE en cas d'erreur. - <parameter>result_array</parameter> doit avoir été passé par référence, mais il - peut être de n'importe quel type, étant donné qu'il sera converti en tableau. - Le tableau contiendra les valeurs des colonnes, ces dernières étant numérotées à - partir de 0. - </para> - </refsect1> - </refentry> - - - <refentry id="function.odbc-fetch-row"> - <refnamediv> - <refname>odbc_fetch_row</refname> - <refpurpose>Lit une ligne de résultat.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>odbc_fetch_row</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>int <parameter><optional>row_number</optional></parameter></paramdef> - </funcsynopsis> - <para> - Si <function>odbc_fetch_row</function> a réussi, TRUE est retourné. - Si il n'y avait plus de ligne, ou en cas d'erreur, FALSE est retourné. - </para> - - <para> - <function>odbc_fetch_row</function> lit une ligne dans le résultat identifié par - <parameter>result_id</parameter> et retourné par <function>odbc_do</function> ou - <function>odbc_exec</function>. - Après <function>odbc_fetch_row</function>, les champs seront accessibles avec la - fonction <function>odbc_result</function>. - </para> - - <para> - Si <parameter><optional>row_number</optional></parameter> est omis, - <parameter>row_number</parameter> va tenter de lire la prochaîne ligne dans le - résultat. Des appels répétés à <function>odbc_fetch_row</function> avec et sans - paramètre <parameter>row_number</parameter> peuvent être combinés librement. - </para> - - <para> - Pour passer en revue toutes les lignes d'un résultat plusieurs fois, - vous pouvez appeler <function>odbc_fetch_row</function> avec row_number = 1, - puis continue à appeler <function>odbc_fetch_row</function> sans le paramètre - <parameter>row_number</parameter> pour passer en revue tout le résultat. Si un - pilote ne supporte pas la lecture des lignes par numéro, le paramètre sera ignoré. - </para> - </refsect1> - </refentry> - - - <refentry id="function.odbc-field-name"> - <refnamediv> - <refname>odbc_field_name</refname> - <refpurpose>Lit le nom de la colonne.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>string <function>odbc_field_name</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>int <parameter>field_number</parameter></paramdef> - </funcsynopsis> - <para> - <function>odbc_field_name</function> lit le nom de la colonne dont l'index est - <parameter>field_number</parameter>. La numérotation des champs commence à 1. - FALSE est retourné en cas d'erreur. - </para> - </refsect1> - </refentry> - - - - <refentry id="function.odbc-field-type"> - <refnamediv> - <refname>odbc_field_type</refname> - <refpurpose>Type de données d'un champs.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>string <function>odbc_field_type</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>int <parameter>field_number</parameter></paramdef> - </funcsynopsis> - <para> - <function>odbc_field_type</function> retourne le type de données SQL d'un champs, - identifié par son index. La numérotation des champs commence à 1. - </para> - </refsect1> - </refentry> - - <refentry id="function.odbc-field-len"> - <refnamediv> - <refname>odbc_field_len</refname> - <refpurpose>Lit la longueur d'un champs.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>odbc_field_len</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>int <parameter>field_number</parameter></paramdef> - </funcsynopsis> - <para> - <function>odbc_field_len</function> retourne la longueur du champs référence par - le nombre <parameter>field_number</parameter>, dans la connexion ODBC - <parameter>result_id</parameter>. Les numéros de champs commencent à 1. - </para> - </refsect1> - </refentry> - - - <refentry id="function.odbc-free-result"> - <refnamediv> - <refname>odbc_free_result</refname> - <refpurpose>Libère les ressources associées à un résultat</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>odbc_free_result</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - </funcsynopsis> - <para> - Retourne toujours TRUE.</para> - <para> - <function>odbc_free_result</function> n'est nécessaire que si vous craignez - d'utiliser trop de mémoire lors de l'exécution de votre script. Tous les - résultats en mémoire seront libérés dès la fin du script. Mais, si vous êtes sûr - que vous n'aurez plus besoin d'un résultat jusqu'à la fin de votre script, vous - pouvez appeler <function>odbc_free_result</function>, et la mémoire associée à - <parameter>result_id</parameter> sera libérée. - </para> - <para> - <note><simpara> - Si auto-validation est désactivée (voir <function>odbc_autocommit</function>) - et que vous appelez <function>odbc_free_result</function> avant de valider vos - requêtes, toutes les transactions préparées seront annulées. - </simpara></note></para> - </refsect1> - </refentry> - - - <refentry id="function.odbc-longreadlen"> - <refnamediv> - <refname>odbc_longreadlen</refname> - <refpurpose>Gestion des colonnes de type LONG.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>odbc_longreadlen</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>int <parameter>length</parameter></paramdef> - </funcsynopsis> - <para> - Types ODBC SQL affectés: LONG, LONGVARBINARY. - </para> - <para> - Le nombre d'octets retournés à PHP est contrôlé par le paramètre - <parameter>length</parameter>. Si sa valeur est 0, les colonnes de type Long - seront transformées en chaîne vide. - </para> - <note><simpara> - La gestion des types LONGVARBINARY est aussi affectée par - <function>odbc_binmode</function>. - </simpara> - </note> - </refsect1> - </refentry> - - - <refentry id="function.odbc-num-fields"> - <refnamediv> - <refname>odbc_num_fields</refname> - <refpurpose>Nombre de colonnes dans un résultat</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>odbc_num_fields</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - </funcsynopsis> - <para> - <function>odbc_num_fields</function> retourne le nombre de colonnes dans un - résultat ODBC. Cette fonction retournera -1 en cas d'erreur. L'argument est un - identifiant de résultat valide, retourné par <function>odbc_exec</function>. - </para> - </refsect1> - </refentry> - - <refentry id="function.odbc-pconnect"> - <refnamediv> - <refname>odbc_pconnect</refname> - <refpurpose>Ouvre une connexion persistante à une source de données.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>odbc_pconnect</function></funcdef> - <paramdef>string <parameter>dsn</parameter></paramdef> - <paramdef>string <parameter>user</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - <paramdef>int <parameter><optional>cursor_type</optional></parameter></paramdef> - </funcsynopsis> - <para> - Retourne un identifiant de connexion ODBC ou 0 (FALSE) en cas d'erreur. - Cette fonction se comporte de manière similaire à <function>odbc_connect</function>, - mais la connexion ouverte n'est pas vraiment terminée lorsque le script est - terminé. Les prochaînes requêtes qui se feront sur une connexion dont - les <parameter>dsn</parameter>, <parameter>user</parameter>, - <parameter>password</parameter> sont les mêmes que celle-ci (avec - <function>odbc_connect</function> et <function>odbc_pconnect</function>) - réutiliseront la connexion ouverte. - </para> - <para> - <note><simpara> - Les connexions persistantes n'ont aucun effet si PHP est utilisé comme CGI. - </simpara></note></para> - <para> - Pour plus de détails sur le paramètre optionnel <parameter>cursor_type</parameter>, - voyez <function>odbc_connect</function>. Pour plus de détails sur les connexions - persistantes, reportez vous à la FAQ PHP. - </para> - </refsect1> - </refentry> - -<refentry id="function.odbc-prepare"> - <refnamediv> - <refname>odbc_prepare</refname> - <refpurpose>Prépare une commande pour l'exécution </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>odbc_prepare</function></funcdef> - <paramdef>int <parameter>connection_id</parameter></paramdef> - <paramdef>string <parameter>query_string</parameter></paramdef> - </funcsynopsis> - <para> - Prépare une commande pour l'exécution.</para> - <para> - Retourne un identifiant de résultat ODBC si la commande SQL a été préparée - avec succès. L'identifiant peut être utilisé plus tard pour exécuter la commande - avec <function>odbc_execute</function>. - </para> - </refsect1> - </refentry> - - <refentry id="function.odbc-num-rows"> - <refnamediv> - <refname>odbc_num_rows</refname> - <refpurpose>Nombre de ligne dans un résultat.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>odbc_num_rows</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - </funcsynopsis> - <para> - <function>odbc_num_rows</function> retourne le nombre de lignes dans un résultat - ODBC. Cette fonction retournera -1 en cas d'erreur. Pour les commandes INSERT, - UPDATE et DELETE, <function>odbc_num_rows</function> retourne le nombre de ligne - affectées. Pour les commandes SELECT, ce <literal>PEUT</literal> le nombre de - lignes disponibles, mais ce n'est pas certains. - </para> - <para> - Note: <function>odbc_num_rows</function> après un SELECT retournera -1 - avec de nombreux pilotes. - </para> - </refsect1> - </refentry> - - <refentry id="function.odbc-result"> - <refnamediv> - <refname>odbc_result</refname> - <refpurpose>Lit les données de résultat.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>string <function>odbc_result</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>mixed <parameter>field</parameter></paramdef> - </funcsynopsis> - <para> - Retourne le contenu d'un champs. - </para> - <para> - <parameter>field</parameter> peut être aussi bien un entier, contenant le numéro - de colonne du champs, dans le résultat, ou bien une chaîne de caractère, qui - représente le nom du champs. Par exemple: - <informalexample><programlisting> - $item_3 = odbc_result($Query_ID, 3 ); - $item_val = odbc_result($Query_ID, "val"); - </programlisting></informalexample></para> - <para> - Le premier appel à <function>odbc_result</function> retourne la valeur du troisième - champs de la ligne courante, du résultat <parameter>result_id</parameter>. - Le deuxième appel à <function>odbc_result</function> retourne la valeur du - troisième champs dont le nom est "val" de la ligne courante, du résultat - <parameter>result_id</parameter>. Une erreur survient si le paramètre de colonne - est inférieur à 1, ou dépasse le nombre de colonnes du résultat. De la même - manière, une erreur survient si le nom du champs passé ne correspond à aucun - champs dans le résultat. - </para> - - <para> - Les index de champs commencent à 1. Pour plus d'informations sur la façon de lire - des colonnes de type binaire ou long, reportez vous à - <function>odbc_binmode</function> et <function>odbc_longreadlen</function>. - -</para> - </refsect1> - </refentry> - - <refentry id="function.odbc-result-all"> - <refnamediv> - <refname>odbc_result_all</refname> - <refpurpose>Affiche le résultat sous la forme d'une table HTML.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>odbc_result_all</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>string <parameter><optional>format</optional></parameter></paramdef> - </funcsynopsis> - <para> - Retourne le nombre de lignes dans le résultat, ou FALSE en cas d'erreur. - </para> - - <para> - <function>odbc_result_all</function> affiche toutes les lignes d'un résultat. - L'affichage se fait au format HTML. Avec l'option <parameter>format</parameter>, - il est possible de modifier l'aspect global de la table. - </para> - </refsect1> - </refentry> - - - <refentry id="function.odbc-rollback"> - <refnamediv> - <refname>odbc_rollback</refname> - <refpurpose>Annule une transaction</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>odbc_rollback</function></funcdef> - <paramdef>int <parameter>connection_id</parameter></paramdef> - </funcsynopsis> - <para> - Annule toutes les transactions sur la connexion - <parameter>connection_id</parameter>. Retourne TRUE en cas de succès, et - FALSE en cas d'echec. - </para> - </refsect1> - </refentry> - - <refentry id="function.odbc-setoption"> - <refnamediv> - <refname>odbc_setoption</refname> - <refpurpose> - Modifie les paramètres ODBC. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>odbc_setoption</function></funcdef> - <paramdef>int <parameter>id</parameter></paramdef> - <paramdef>int <parameter>function</parameter></paramdef> - <paramdef>int <parameter>option</parameter></paramdef> - <paramdef>int <parameter>param</parameter></paramdef> - </funcsynopsis> - <para> - Cette fonction donne accès aux options ODBC pour une connexion particulière - ou un résultat de requête. Elle a été écrite pour aider à la résolution de - problème liés aux pilotes ODBC récalcitrants. Vous aurez sûrement à utiliser - cette fonction si vous êtes un programmeur ODBC et que vous comprenez les divers - effets des options disponibles. Vous aurez aussi besoin d'un bon manuel de - référence pour comprendre les options et leur usage. Différentes versions de - pilotes supportent différentes versions d'options. - </para> - <para> - Etant donné que les effets peuvent varier d'un pilote à l'autre, l'utilisation de - cette fonction dans des scripts voués à être livrés au public est très fortement - déconseillée. De plus, certaines options ODBC ne sont pas disponibles car elles - doivent être fixées avant l'établissement de la connexion. Cependant, si dans - un cas bien spécifique, cette fonction vous permet d'utiliser PHP sans que votre - patron vous pousse à utiliser un produit commecial, alors cela n'a pas - d'importance. - </para> - <para> - <parameter>Id</parameter> est un identifiant de connexion, ou un identifiant de - résultat, pour lequel vous souhaitez modifier des options. - Pour SQLSetConnectOption(), c'est un identifiant de connexion. - Pour SQLSetStmtOption(), c'est un identifiant de résultat. - </para> - <para> - <parameter>function</parameter> est la fonction ODBC à utiliser. La valeur doit - être de 1 pour utiliser SQLSetConnectOption() et 2 pour SQLSetStmtOption(). - </para> - <para> - Le paramètre <parameter>option</parameter> est l'option à modifier. - </para> - <para> - Le paramètre <parameter>param</parameter> est la valeur de l'option - <parameter>option</parameter>. - - <example> - <title>ODBC Setoption Examples</title> - <programlisting role="php"> -// 1. L'option 102 de SQLSetConnectOption() est SQL_AUTOCOMMIT. -// 1 de SQL_AUTOCOMMIT est SQL_AUTOCOMMIT_ON. -// Cet exemple a le meme effet que -// odbc_autocommit($conn, TRUE); - -odbc_setoption ($conn, 1, 102, 1); - -// 2. Option 0 de SQLSetStmtOption() est SQL_QUERY_TIMEOUT. -// Cet exemple fixe le délai d'expiration à 30 secondes. - -$result = odbc_prepare ($conn, $sql); -odbc_setoption ($result, 2, 0, 30); -odbc_execute ($result); - </programlisting> - </example></para> - </refsect1> - </refentry> - - </reference> - - + <reference id="ref.odbc"> + <title>ODBC</title> + <titleabbrev>ODBC</titleabbrev> + <partintro> + <simpara> + En plus du support de l'ODBC normal, l'ODBC unifié de PHP vous donne + accès à diverses bases de données qui ont emprunté la sémantique + des API ODBC pour implémenter leur propres API. Au lieu de + maintenir de multiples pilotes qui sont similaires, ces + pilotes ont été rassemblés dans un jeu de fonctions ODBC uniques. + </simpara> + <simpara> + Les bases de données suivantes sont supportées par l'ODBC unifié : + <ulink url="&url.adabas;">Adabas D</ulink>, + <ulink url="&url.ibmdb2;">IBM DB2</ulink>, + <ulink url="&url.iodbc;">iODBC</ulink>, + <ulink url="&url.solid;">Solid</ulink>, et + <ulink url="&url.sybase;">Sybase SQL Anywhere</ulink>. + </simpara> + <simpara> + Reportez vous à <link + linkend="database-support-options">Installation sous Unix</link> + pour plus de détails sur les configurations de ces serveurs. + </simpara> + <note> + <simpara> + Il n'y a pas d'ODBC utilisé lors des connexions aux bases de données + ci-dessus. Les fonctions que vous utiliserez portent des noms + évocateurs, et utilisent les mêmes syntaxes que leurs cousines + d'ODBC. + </simpara> + </note> + </partintro> + <refentry id="function.odbc-autocommit"> + <refnamediv> + <refname>odbc_autocommit</refname> + <refpurpose>Mode auto-validation</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>odbc_autocommit</function></funcdef> + <paramdef>int <parameter>connection_id</parameter></paramdef> + <paramdef>int <parameter><optional>OnOff</optional></parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Sans paramètre <parameter>OnOff</parameter>, + <function>odbc_autocommit</function> retourne le statut d'auto-validation + de la connexion <parameter>connection_id</parameter>. TRUE si le mode + est activé, FALSE si il ne l'est pas, ou si une erreur survient. + </para> + <para> + Si <parameter>OnOff</parameter> vaut TRUE, l'auto-validation est + activée. Si il est FALSE, l'auto-validation est désactivée. + Retourne TRUE en cas de succès, FALSE en cas d'échec. + </para> + <para> + Par défaut, l'auto-validation est activée. Désactiver + l'auto-validation est équivalent à démarrer une + transaction. + </para> + <simpara> + Voir aussi + <function>odbc_commit</function> et <function>odbc_rollback</function>. + </simpara> + </refsect1> + </refentry> + <refentry id="function.odbc-binmode"> + <refnamediv> + <refname>odbc_binmode</refname> + <refpurpose>Gestion des colonnes de données binaires.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>odbc_binmode</function></funcdef> + <paramdef>int <parameter>result_id</parameter></paramdef> + <paramdef>int <parameter>mode</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Types ODBC SQL affectés: BINARY, VARBINARY, LONGVARBINARY. + </para> + <itemizedlist> + <listitem> + <simpara> + ODBC_BINMODE_PASSTHRU: Mode Passthru + </simpara> + </listitem> + <listitem> + <simpara> + ODBC_BINMODE_RETURN: Retourne tel quel. + </simpara> + </listitem> + <listitem> + <simpara> + ODBC_BINMODE_CONVERT: Converti en char et retourne la valeur. + </simpara> + </listitem> + </itemizedlist> + <para> + Lorsqu'une donnée SQL est convertie en caractère C, + les 8 bits du caractère source sont représentés + par deux caractères ASCII. Ces caractères sont des + représentations ASCII des nombres au format hexadécimal. + Par exemple, le binaire 00000001 est converti en <literal>"01"</literal> + et le binaire 11111111 est converti en <literal>"FF"</literal>. + <table> + <title>Conversion des LONGVARBINARY </title> + <tgroup cols="3"> + <thead> + <row> + <entry>mode</entry> + <entry>longueur</entry> + <entry>résultat</entry> + </row> + </thead> + <tbody> + <row> + <entry>ODBC_BINMODE_PASSTHRU</entry> + <entry>0</entry> + <entry>passthru</entry> + </row> + <row> + <entry>ODBC_BINMODE_RETURN</entry> + <entry>0</entry> + <entry>passthru</entry> + </row> + <row> + <entry>ODBC_BINMODE_CONVERT</entry> + <entry>0</entry> + <entry>passthru</entry> + </row> + <row> + <entry>ODBC_BINMODE_PASSTHRU</entry> + <entry>0</entry> + <entry>passthru</entry> + </row> + <row> + <entry>ODBC_BINMODE_PASSTHRU</entry> + <entry>>0</entry> + <entry>passthru</entry> + </row> + <row> + <entry>ODBC_BINMODE_RETURN</entry> + <entry>>0</entry> + <entry>Tel quel</entry> + </row> + <row> + <entry>ODBC_BINMODE_CONVERT</entry> + <entry>>0</entry> + <entry>Caractère</entry> + </row> + </tbody> + </tgroup> + </table> + </para> + <para> + Si <function>odbc_fetch_into</function> est utilisé, passthru + signifie qu'une chaîne vide sera retournée pour ces colonnes. + </para> + <para> + Si <parameter>result_id</parameter> vaut <literal>0</literal>, ces + paramètres seront appliqués aux nouveaux résultats. + <note> + <simpara> + La valeur par défaut de <literal>4096</literal> est 4096 et + les valeurs par défaut de odbc_binmode est + <literal>ODBC_BINMODE_RETURN</literal>. La gestion des colonnes + binaires est aussi modifié par <function>odbc_longreadlen</function>. + </simpara> + </note> + </para> + </refsect1> + </refentry> + <refentry id="function.odbc-close"> + <refnamediv> + <refname>odbc_close</refname> + <refpurpose>Ferme une connexion ODBC.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>void <function>odbc_close</function></funcdef> + <paramdef>int <parameter>connection_id</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>odbc_close</function> ferme la connexion avec une source de données, + représentée par l'identifiant de connexion. + <note> + <simpara> + <function>odbc_close</function> échouera si il y a des + transactions en cours sur cette connexion. Dans ce cas, la connexion + restera ouverte. + </simpara> + </note> + </para> + </refsect1> + </refentry> + <refentry id="function.odbc-close-all"> + <refnamediv> + <refname>odbc_close_all</refname> + <refpurpose>Ferme toutes les connexions ODBC</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>void <function>odbc_close_all</function></funcdef> + <void/> + </funcprototype> + </funcsynopsis> + <para> + <function>odbc_close_all</function> ferme toutes les connexions + ODBC à des sources de données. + <note> + <simpara> + <function>odbc_close_all</function> échouera si il y a des + transactions en cours sur cette connexion. Dans ce cas, la connexion + restera ouverte. + </simpara> + </note> + </para> + </refsect1> + </refentry> + <refentry id="function.odbc-commit"> + <refnamediv> + <refname>odbc_commit</refname> + <refpurpose>Valide une transaction ODBC </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>odbc_commit</function></funcdef> + <paramdef>int <parameter>connection_id</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Retourne TRUE en case de succès, FALSE en cas d'erreur. Toutes + les connexions en cours sur <parameter>connection_id</parameter> sont + validées. + </para> + </refsect1> + </refentry> + <refentry id="function.odbc-connect"> + <refnamediv> + <refname>odbc_connect</refname> + <refpurpose>Connexion à une source</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>odbc_connect</function></funcdef> + <paramdef>string <parameter>dsn</parameter></paramdef> + <paramdef>string <parameter>user</parameter></paramdef> + <paramdef>string <parameter>password</parameter></paramdef> + <paramdef>int <parameter><optional>cursor_type</optional></parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>odbc_connect</function> etourne un identifiant de connexion ODBC + ou 0 (FALSE) en cas d'erreur. + </para> + <simpara> + L'identifiant de connexion retournée par cette fonction est + nécessaire pour toutes les autres fonctions ODBC. Vous pouvez + avoir de multiples connexions en même temps. Le quatrième + paramètre fixe le type de pointeur de résultat + utilisé pour cette connexion. Ce paramètre n'est + généralement pas nécessaire, mais il peut être + utile pour contourner certains problèmes ODBC. + </simpara> + <simpara> + Avec certains pilotes ODBC, l'exécution de procédures + enregistrées complexes peut produire l'erreur suivante : + "Cannot open a cursor on a stored procedure that has anything other + than a single select statement in it", ce qui signifie : "Impossible + de créer un pointeur de résultat dans une procédure + enregistrée qui est réduite à une simple selection + (SELECT)). Utiliser l'option SQL_CUR_USE_ODBC permet d'éviter + cette erreur. De plus, certains pilotes ne supportent le paramètre + optionnel de numéro de ligne dans <function>odbc_fetch_row</function>. + SQL_CUR_USE_ODBC peut aussi permettre de résoudre ces problèmes. + </simpara> + <simpara> + Les constantes suivantes sont définies comme type de pointeur : + </simpara> + <para> + <itemizedlist> + <listitem> + <simpara> + SQL_CUR_USE_IF_NEEDED + </simpara> + </listitem> + <listitem> + <simpara> + SQL_CUR_USE_ODBC + </simpara> + </listitem> + <listitem> + <simpara> + SQL_CUR_USE_DRIVER + </simpara> + </listitem> + <listitem> + <simpara> + SQL_CUR_DEFAULT + </simpara></listitem> + </itemizedlist> + </para> + <simpara> + Pour les connexions persistantes, reportez vous à + <function>odbc_pconnect</function>. + </simpara> + </refsect1> + </refentry> + <refentry id="function.odbc-cursor"> + <refnamediv> + <refname>odbc_cursor</refname> + <refpurpose>Lecture du pointeur de fiche courante (cursorname).</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>odbc_cursor</function></funcdef> + <paramdef>int <parameter>result_id</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>odbc_cursor</function> lit le pointeur de fiche courante + (cursorname) pour le résultat <parameter>result_id</parameter>. + </para> + </refsect1> + </refentry> + <refentry id="function.odbc-do"> + <refnamediv> + <refname>odbc_do</refname> + <refpurpose>Synonyme de <function>odbc_exec</function></refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>odbc_do</function></funcdef> + <paramdef>int <parameter>conn_id</parameter></paramdef> + <paramdef>string <parameter>query</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>odbc_do</function> excécute la requête + <parameter>query</parameter> avec la connexion <parameter>conn_id</parameter>. + </para> + </refsect1> + </refentry> + <refentry id="function.odbc-exec"> + <refnamediv> + <refname>odbc_exec</refname> + <refpurpose> + Prépare et exécute une requête SQL. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>odbc_exec</function></funcdef> + <paramdef>int <parameter>connection_id</parameter></paramdef> + <paramdef>string <parameter>query_string</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>odbc_exec</function> retourne FALSE en cas d'erreur, ou bien + retourne un identifiant de résultat ODBC en cas + d'exécution réussie. + </para> + <para> + <function>odbc_exec</function> envoie une commande SQL à + la source de données représentée par + <parameter>connection_id</parameter>. Ce paramètre doit + être un identifiant valide de connexion, retourné par + <function>odbc_connect</function> ou <function>odbc_pconnect</function>. + </para> + <simpara> + Voir aussi : <function>odbc_prepare</function> et + <function>odbc_execute</function> pour les éxecutions + multiples de requêtes SQL. + </simpara> + </refsect1> + </refentry> +<refentry id="function.odbc-execute"> + <refnamediv> + <refname>odbc_execute</refname> + <refpurpose> + Exécute une requête SQL préparée. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>int <function>odbc_execute</function></funcdef> + <paramdef>int <parameter>result_id</parameter></paramdef> + <paramdef>array + <parameter><optional>parameters_array</optional></parameter></paramdef> + </funcsynopsis> + <para> + <function>odbc_execute</function> exécute une requête SQL + préparée par <function>odbc_prepare</function>. + Retourne TRUE en cas d'exécution réussie, et FALSE + sinon. Le tableau de paramètres + <parameter>parameters_array</parameter> ne sert que si vous avez besoin de + paramètres votre requête. + </para> + </refsect1> + </refentry> + <refentry id="function.odbc-fetch-into"> + <refnamediv> + <refname>odbc_fetch_into</refname> + <refpurpose> + Lit une ligne de résultat, et la place dans un tableau. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>odbc_fetch_into</function></funcdef> + <paramdef>int <parameter>result_id</parameter></paramdef> + <paramdef>int <parameter><optional>rownumber</optional></parameter></paramdef> + <paramdef>array <parameter>result_array</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>odbc_fetch_into</function> retourne le nombre de colonnes + dans le résultat, ou FALSE en cas d'erreur. + <parameter>result_array</parameter> doit avoir été + passé par référence, mais il peut être + de n'importe quel type, étant donné qu'il sera converti en tableau. + Le tableau contiendra les valeurs des colonnes, ces dernières étant numérotées à + partir de 0. + </para> + </refsect1> + </refentry> + <refentry id="function.odbc-fetch-row"> + <refnamediv> + <refname>odbc_fetch_row</refname> + <refpurpose>Lit une ligne de résultat.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>odbc_fetch_row</function></funcdef> + <paramdef>int <parameter>result_id</parameter></paramdef> + <paramdef>int <parameter><optional>row_number</optional></parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Si <function>odbc_fetch_row</function> a réussi, TRUE est + retourné. Si il n'y avait plus de ligne, ou en cas d'erreur, + FALSE est retourné. + </para> + <para> + <function>odbc_fetch_row</function> lit une ligne dans le + résultat identifié par <parameter>result_id</parameter> + et retourné par <function>odbc_do</function> ou + <function>odbc_exec</function>. Après + <function>odbc_fetch_row</function>, les champs seront accessibles avec la + fonction <function>odbc_result</function>. + </para> + <para> + Si <parameter><optional>row_number</optional></parameter> est omis, + <parameter>row_number</parameter> va tenter de lire la prochaîne + ligne dans le résultat. Des appels répétés + à <function>odbc_fetch_row</function> avec et sans paramètre + <parameter>row_number</parameter> peuvent être combinés librement. + </para> + <para> + Pour passer en revue toutes les lignes d'un résultat plusieurs fois, + vous pouvez appeler <function>odbc_fetch_row</function> avec row_number = 1, + puis continue à appeler <function>odbc_fetch_row</function> sans le + paramètre <parameter>row_number</parameter> pour passer en revue + tout le résultat. Si un pilote ne supporte pas la lecture des + lignes par numéro, le paramètre sera ignoré. + </para> + </refsect1> + </refentry> + <refentry id="function.odbc-field-name"> + <refnamediv> + <refname>odbc_field_name</refname> + <refpurpose>Lit le nom de la colonne.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>odbc_field_name</function></funcdef> + <paramdef>int <parameter>result_id</parameter></paramdef> + <paramdef>int <parameter>field_number</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>odbc_field_name</function> lit le nom de la colonne dont + l'index est <parameter>field_number</parameter>. La + numérotation des champs commence à 1. + FALSE est retourné en cas d'erreur. + </para> + </refsect1> + </refentry> + <refentry id="function.odbc-field-num"> + <refnamediv> + <refname>odbc_field_num</refname> + <refpurpose>Numéro de colonne</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>odbc_field_num</function></funcdef> + <paramdef>int <parameter>result_id</parameter></paramdef> + <paramdef>string <parameter>field_name</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>odbc_field_num</function> retourne le numéro de + la colonne nommée <parameter>field_name</parameter>. Ce numéro + correspond à l'index du champs dans le résultat ODBC. La numérotation + commence à 1. <literal>FALSE</literal> est retourné en cas d'erreur. + </para> + </refsect1> + </refentry> + <refentry id="function.odbc-field-type"> + <refnamediv> + <refname>odbc_field_type</refname> + <refpurpose>Type de données d'un champs.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>odbc_field_type</function></funcdef> + <paramdef>int <parameter>result_id</parameter></paramdef> + <paramdef>int <parameter>field_number</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>odbc_field_type</function> retourne le type de données + SQL d'un champs, identifié par son index. La numérotation + des champs commence à 1. + </para> + </refsect1> + </refentry> + <refentry id="function.odbc-field-len"> + <refnamediv> + <refname>odbc_field_len</refname> + <refpurpose>Lit la longueur d'un champs.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>odbc_field_len</function></funcdef> + <paramdef>int <parameter>result_id</parameter></paramdef> + <paramdef>int <parameter>field_number</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>odbc_field_len</function> retourne la longueur du + champs référence par le nombre + <parameter>field_number</parameter>, dans la connexion ODBC + <parameter>result_id</parameter>. Les numéros de + champs commencent à 1. + </para> + </refsect1> + </refentry> + <refentry id="function.odbc-field-precision"> + <refnamediv> + <refname>odbc_field_precision</refname> + <refpurpose>Alias de <function>odbc_field_len</function></refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>odbc_field_precision</function></funcdef> + <paramdef>int <parameter>result_id</parameter></paramdef> + <paramdef>int <parameter>field_number</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>odbc_field_precision</function> retourne la précision + du champs référéncé par son numéro <parameter>field_number</parameter>, + dans le résultat ODBC <parameter>result_id</parameter>. + </para> + <para> + Voir aussi : <function>odbc_field_scale</function> pour connaître + l'échelle d'un nombre à virgule flottante. + </para> + </refsect1> + </refentry> + <refentry id="function.odbc-field-scale"> + <refnamediv> + <refname>odbc_field_scale</refname> + <refpurpose>Lit l'échelle d'un champs</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>odbc_field_scale</function></funcdef> + <paramdef>int <parameter>result_id</parameter></paramdef> + <paramdef>int <parameter>field_number</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>odbc_field_precision</function> retourne l'échelle + du champs référéncé par son numéro de champs <parameter>field_number</parameter> + dans le résultat ODBC <parameter>result_id</parameter>. + </para> + </refsect1> + </refentry> + <refentry id="function.odbc-free-result"> + <refnamediv> + <refname>odbc_free_result</refname> + <refpurpose> + Libère les ressources associées à un résultat + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>odbc_free_result</function></funcdef> + <paramdef>int <parameter>result_id</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Retourne toujours TRUE.</para> + <para> + <function>odbc_free_result</function> n'est nécessaire que + si vous craignez d'utiliser trop de mémoire lors de + l'exécution de votre script. Tous les résultats + en mémoire seront libérés dès la + fin du script. Mais, si vous êtes sûr que vous + n'aurez plus besoin d'un résultat jusqu'à la + fin de votre script, vous pouvez appeler + <function>odbc_free_result</function>, et la + mémoire associée à <parameter>result_id</parameter> + sera libérée. + </para> + <para> + <note> + <simpara> + Si auto-validation est désactivée (voir + <function>odbc_autocommit</function>) et que vous appelez + <function>odbc_free_result</function> avant de valider vos requêtes, + toutes les transactions préparées seront annulées. + </simpara> + </note> + </para> + </refsect1> + </refentry> + <refentry id="function.odbc-longreadlen"> + <refnamediv> + <refname>odbc_longreadlen</refname> + <refpurpose>Gestion des colonnes de type LONG.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>odbc_longreadlen</function></funcdef> + <paramdef>int <parameter>result_id</parameter></paramdef> + <paramdef>int <parameter>length</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Types ODBC SQL affectés: LONG, LONGVARBINARY. + </para> + <para> + Le nombre d'octets retournés à PHP est contrôlé + par le paramètre <parameter>length</parameter>. Si sa valeur est 0, + les colonnes de type Long seront transformées en chaîne vide. + </para> + <note> + <simpara> + La gestion des types LONGVARBINARY est aussi affectée par + <function>odbc_binmode</function>. + </simpara> + </note> + </refsect1> + </refentry> + <refentry id="function.odbc-num-fields"> + <refnamediv> + <refname>odbc_num_fields</refname> + <refpurpose>Nombre de colonnes dans un résultat</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>odbc_num_fields</function></funcdef> + <paramdef>int <parameter>result_id</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>odbc_num_fields</function> retourne le nombre de colonnes dans + un résultat ODBC. Cette fonction retournera -1 en cas d'erreur. + L'argument est un identifiant de résultat valide, retourné + par <function>odbc_exec</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.odbc-pconnect"> + <refnamediv> + <refname>odbc_pconnect</refname> + <refpurpose> + Ouvre une connexion persistante à une source de données. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>odbc_pconnect</function></funcdef> + <paramdef>string <parameter>dsn</parameter></paramdef> + <paramdef>string <parameter>user</parameter></paramdef> + <paramdef>string <parameter>password</parameter></paramdef> + <paramdef>int <parameter><optional>cursor_type</optional></parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Retourne un identifiant de connexion ODBC ou 0 (FALSE) en cas d'erreur. + Cette fonction se comporte de manière similaire à + <function>odbc_connect</function>, mais la connexion ouverte + n'est pas vraiment terminée lorsque le script est + terminé. Les prochaînes requêtes qui se + feront sur une connexion dont les <parameter>dsn</parameter>, + <parameter>user</parameter>, <parameter>password</parameter> + sont les mêmes que celle-ci (avec + <function>odbc_connect</function> et <function>odbc_pconnect</function>) + réutiliseront la connexion ouverte. + </para> + <para> + <note> + <simpara> + Les connexions persistantes n'ont aucun effet + si PHP est utilisé comme CGI. + </simpara> + </note> + </para> + <para> + Pour plus de détails sur le paramètre optionel + <parameter>cursor_type</parameter>, voyez <function>odbc_connect</function>. + Pour plus de détails sur les connexions persistantes, + reportez vous à la FAQ PHP. + </para> + </refsect1> + </refentry> +<refentry id="function.odbc-prepare"> + <refnamediv> + <refname>odbc_prepare</refname> + <refpurpose>Prépare une commande pour l'exécution </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>odbc_prepare</function></funcdef> + <paramdef>int <parameter>connection_id</parameter></paramdef> + <paramdef>string <parameter>query_string</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>odbc_prepare</function> prépare une commande pour + l'exécution. + </para> + <para> + Retourne un identifiant de résultat ODBC si la commande SQL + a été préparée avec succès. + L'identifiant peut être utilisé plus tard pour + exécuter la commande avec <function>odbc_execute</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.odbc-num-rows"> + <refnamediv> + <refname>odbc_num_rows</refname> + <refpurpose>Nombre de ligne dans un résultat.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>odbc_num_rows</function></funcdef> + <paramdef>int <parameter>result_id</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>odbc_num_rows</function> retourne le nombre de lignes + dans un résultat ODBC. Cette fonction retournera -1 en + cas d'erreur. Pour les commandes INSERT, UPDATE et DELETE, + <function>odbc_num_rows</function> retourne le nombre de ligne + affectées. Pour les commandes SELECT, ce <literal>PEUT</literal> + le nombre de lignes disponibles, mais ce n'est pas certain. + </para> + <para> + Note: <function>odbc_num_rows</function> après un SELECT + retournera -1 avec de nombreux pilotes. + </para> + </refsect1> + </refentry> + <refentry id="function.odbc-result"> + <refnamediv> + <refname>odbc_result</refname> + <refpurpose>Lit les données de résultat.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>odbc_result</function></funcdef> + <paramdef>int <parameter>result_id</parameter></paramdef> + <paramdef>mixed <parameter>field</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>odbc_result</function> retourne le contenu d'un champs. + </para> + <para> + <parameter>field</parameter> peut être aussi bien un entier, + contenant le numéro de colonne du champs, dans le + résultat, ou bien une chaîne de caractère, qui + représente le nom du champs. Par exemple: + <informalexample> + <programlisting> + $item_3 = odbc_result($Query_ID, 3 ); + $item_val = odbc_result($Query_ID, "val"); + </programlisting> + </informalexample> + </para> + <para> + Le premier appel à <function>odbc_result</function> retourne + la valeur du troisième champs de la ligne courante, du + résultat <parameter>result_id</parameter>. Le deuxième + appel à <function>odbc_result</function> retourne la valeur du + troisième champs dont le nom est "val" de la ligne courante, du + résultat <parameter>result_id</parameter>. Une erreur survient si + le paramètre de colonne est inférieur à 1, ou + dépasse le nombre de colonnes du résultat. De la même + manière, une erreur survient si le nom du champs passé ne + correspond à aucun champs dans le résultat. + </para> + <para> + Les index de champs commencent à 1. Pour plus d'informations + sur la façon de lire des colonnes de type binaire ou long, + reportez vous à <function>odbc_binmode</function> et + <function>odbc_longreadlen</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.odbc-result-all"> + <refnamediv> + <refname>odbc_result_all</refname> + <refpurpose> + Affiche le résultat sous la forme d'une table HTML. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>odbc_result_all</function></funcdef> + <paramdef>int <parameter>result_id</parameter></paramdef> + <paramdef>string <parameter><optional>format</optional></parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>odbc_result_all</function> retourne le nombre de lignes + dans le résultat, ou FALSE en cas d'erreur. + </para> + <para> + <function>odbc_result_all</function> affiche toutes les lignes + d'un résultat. L'affichage se fait au format HTML. Avec + l'option <parameter>format</parameter>, il est possible de + modifier l'aspect global de la table. + </para> + </refsect1> + </refentry> + <refentry id="function.odbc-rollback"> + <refnamediv> + <refname>odbc_rollback</refname> + <refpurpose>Annule une transaction</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>odbc_rollback</function></funcdef> + <paramdef>int <parameter>connection_id</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>odbc_rollback</function> annule toutes les transactions sur + la connexion <parameter>connection_id</parameter>. Retourne TRUE en + cas de succès, et FALSE en cas d'echec. + </para> + </refsect1> + </refentry> + <refentry id="function.odbc-setoption"> + <refnamediv> + <refname>odbc_setoption</refname> + <refpurpose> + Modifie les paramètres ODBC. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>odbc_setoption</function></funcdef> + <paramdef>int <parameter>id</parameter></paramdef> + <paramdef>int <parameter>function</parameter></paramdef> + <paramdef>int <parameter>option</parameter></paramdef> + <paramdef>int <parameter>param</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>odbc_setoption</function> donne accès aux options + ODBC pour une connexion particulière ou un résultat de + requête. Elle a été écrite pour aider à + la résolution de problème liés aux pilotes ODBC + récalcitrants. Vous aurez sûrement à utiliser + cette fonction si vous êtes un programmeur ODBC et que vous + comprenez les divers effets des options disponibles. Vous aurez aussi + besoin d'un bon manuel de référence pour comprendre les + options et leur usage. Différentes versions de pilotes supportent + différentes versions d'options. + </para> + <para> + Etant donné que les effets peuvent varier d'un pilote à + l'autre, l'utilisation de cette fonction dans des scripts voués + à être livrés au public est très fortement + déconseillée. De plus, certaines options ODBC ne sont + pas disponibles car elles doivent être fixées avant + l'établissement de la connexion. Cependant, si dans un cas + bien spécifique, cette fonction vous permet d'utiliser PHP + sans que votre patron vous pousse à utiliser un produit commercial, + alors cela n'a pas d'importance. + </para> + <para> + <parameter>Id</parameter> est un identifiant de connexion, ou un identifiant + de résultat, pour lequel vous souhaitez modifier des options. + Pour SQLSetConnectOption(), c'est un identifiant de connexion. + Pour SQLSetStmtOption(), c'est un identifiant de résultat. + </para> + <para> + <parameter>function</parameter> est la fonction ODBC à utiliser. + La valeur doit être de 1 pour utiliser SQLSetConnectOption() et 2 + pour SQLSetStmtOption(). + </para> + <para> + Le paramètre <parameter>option</parameter> est l'option à + modifier. + </para> + <para> + Le paramètre <parameter>param</parameter> est la valeur de l'option + <parameter>option</parameter>. + <example> + <title>Exemple de modification d'option ODBC</title> + <programlisting role="php"> +// 1. L'option 102 de SQLSetConnectOption() est SQL_AUTOCOMMIT. +// 1 de SQL_AUTOCOMMIT est SQL_AUTOCOMMIT_ON. +// Cet exemple a le meme effet que +// odbc_autocommit($conn, TRUE); +odbc_setoption ($conn, 1, 102, 1); +// 2. Option 0 de SQLSetStmtOption() est SQL_QUERY_TIMEOUT. +// Cet exemple fixe le délai d'expiration à 30 secondes. +$result = odbc_prepare ($conn, $sql); +odbc_setoption ($result, 2, 0, 30); +odbc_execute ($result); + </programlisting> + </example> + </para> + </refsect1> + </refentry> + <refentry id="function.odbc-tables"> + <refnamediv> + <refname>odbc_tables</refname> + <refpurpose> + Liste les tables d'une source. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>odbc_tables</function></funcdef> + <paramdef>int <parameter>connection_id</parameter></paramdef> + <paramdef>string <parameter><optional>qualifier</optional></parameter></paramdef> + <paramdef>string <parameter><optional>owner</optional></parameter></paramdef> + <paramdef>string <parameter><optional>name</optional></parameter></paramdef> + <paramdef>string <parameter><optional>types</optional></parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>odbc_tables</function> liste toutes les tables de + la source et retourne un identifiant de résultat ODBC, ou bien + <literal>FALSE</literal> en cas d'erreur. + </para> + <para> + Le résultat contient les colonnes suivantes : + <itemizedlist> + <listitem><simpara>TABLE_QUALIFIER</simpara></listitem> + <listitem><simpara>TABLE_OWNER</simpara></listitem> + <listitem><simpara>TABLE_NAME</simpara></listitem> + <listitem><simpara>TABLE_TYPE</simpara></listitem> + <listitem><simpara>REMARKS</simpara></listitem> + </itemizedlist> + </para> + <simpara> + Le résultat est ordonné grâce aux options TABLE_TYPE, TABLE_QUALIFIER, + TABLE_OWNER et TABLE_NAME. + </simpara> + <para> + Les paramètres <parameter>owner</parameter> et <parameter>name</parameter> + acceptent des masques de recherche ('%' pour remplacer zéro ou plus caractères, + et '_' pour n'en remplacer qu'un seul). + </para> + <para> + Pour supporter les énumérations de qualifiers, propriétaire et types + de tables, la sémantique suivante pour les paramètres + <parameter>qualifier</parameter>, <parameter>owner</parameter>, + <parameter>name</parameter>, et <parameter>table_type</parameter> + sont disponibles : + <itemizedlist> + <listitem> + <simpara> + Si <parameter>qualifier</parameter> est un signe de pourcentage (%), + et <parameter>owner</parameter> et <parameter>name</parameter> sont + des chaînes vides, alors le résultat contient la liste des + qualifiers valides pour la source. (toutes les colonnes hormis + TABLE_QUALIFIER contiennent NULL). + </simpara> + </listitem> + <listitem> + <simpara> + Si <parameter>owner</parameter> est un signe de pourcentage (%), + et <parameter>qualifier</parameter> et <parameter>name</parameter> + sont des chaînes vides, alors le résultat contient la liste des + propriétaires de la source (toutes les colonnes hormis + TABLE_OWNER contiennent NULL). + </simpara> + </listitem> + <listitem> + <simpara> + Si <parameter>table_type</parameter> est un signe de pourcentage (%), + et <parameter>qualifier</parameter>, <parameter>owner</parameter> et + <parameter>name</parameter> sont des chaînes vides, alors le résultat + contient la liste des types de tables de la source (toutes les colonnes hormis + TABLE_TYPE contiennent NULL). + </simpara> + </listitem> + </itemizedlist> + </para> + <para> + Si <parameter>table_type</parameter> n'est pas une chaîne vide, + il doit contenir une liste de valeurs, séparées par des virgules, + qui representent les types recherchés. Chaque valeur peut être + insérée entre guillements simples ('), ou sans guillements. Par + exemple "'TABLE','VIEW'" ou "TABLE, VIEW". Si la source de données + ne supporte par un type de table donné, <function>odbc_tables</function> + ne retournera aucun résultat pour ce type. + </para> + <simpara> + Voir aussi <function>odbc_tableprivileges</function> pour connaître + les droits associés. + </simpara> + </refsect1> + </refentry> + <refentry id="function.odbc-tableprivileges"> + <refnamediv> + <refname>odbc_tableprivileges</refname> + <refpurpose> + Liste les tables et leurs privilèges + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>odbc_tableprivileges</function></funcdef> + <paramdef>int <parameter>connection_id</parameter></paramdef> + <paramdef>string <parameter><optional>qualifier</optional></parameter></paramdef> + <paramdef>string <parameter><optional>owner</optional></parameter></paramdef> + <paramdef>string <parameter><optional>name</optional></parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>odbc_tableprivileges</function> liste les tables de la source + et leurs droits associés. Retourne un identifiant de résultat + ODBC, ou bien FALSE en cas d'erreur. + </para> + <para> + Le résultat possède les colonnes suivantes : + <itemizedlist> + <listitem><simpara>TABLE_QUALIFIER</simpara></listitem> + <listitem><simpara>TABLE_OWNER</simpara></listitem> + <listitem><simpara>TABLE_NAME</simpara></listitem> + <listitem><simpara>GRANTOR</simpara></listitem> + <listitem><simpara>GRANTEE</simpara></listitem> + <listitem><simpara>PRIVILEGE</simpara></listitem> + <listitem><simpara>IS_GRANTABLE</simpara></listitem> + </itemizedlist> + </para> + <simpara> + Le résultat est ordonné par TABLE_QUALIFIER, TABLE_OWNER et + TABLE_NAME. + </simpara> + <para> + Les paramètres <parameter>owner</parameter> et <parameter>name</parameter> + acceptent des masques de recherche ('%' pour remplacer zéro ou plus caractères, + et '_' pour n'en remplacer qu'un seul). + </para> + </refsect1> + </refentry> + <refentry id="function.odbc-columns"> + <refnamediv> + <refname>odbc_columns</refname> + <refpurpose> + Liste les colonnes d'une table + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>odbc_columns</function></funcdef> + <paramdef>int <parameter>connection_id</parameter></paramdef> + <paramdef>string <parameter><optional>qualifier</optional></parameter></paramdef> + <paramdef>string <parameter><optional>owner</optional></parameter></paramdef> + <paramdef>string <parameter><optional>table_name</optional></parameter></paramdef> + <paramdef>string <parameter><optional>column_name</optional></parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>odbc_columns</function> liste toutes les colonnes + de la source dedonnées. Retourne un identifiant de résultat + ODBC, ou bien FALSE en cas d'erreur. + </para> + <para> + Le résultat possède les colonnes suivantes : + <itemizedlist> + <listitem><simpara>TABLE_QUALIFIER</simpara></listitem> + <listitem><simpara>TABLE_OWNER</simpara></listitem> + <listitem><simpara>TABLE_NAME</simpara></listitem> + <listitem><simpara>COLUMN_NAME</simpara></listitem> + <listitem><simpara>DATA_TYPE</simpara></listitem> + <listitem><simpara>TYPE_NAME</simpara></listitem> + <listitem><simpara>PRECISION</simpara></listitem> + <listitem><simpara>LENGTH</simpara></listitem> + <listitem><simpara>SCALE</simpara></listitem> + <listitem><simpara>RADIX</simpara></listitem> + <listitem><simpara>NULLABLE</simpara></listitem> + <listitem><simpara>REMARKS</simpara></listitem> + </itemizedlist> + </para> + <simpara> + Le résultat est ordonné par TABLE_QUALIFIER, TABLE_OWNER et + TABLE_NAME. + </simpara> + <para> + Les paramètres <parameter>owner</parameter>, <parameter>column_name</parameter> + et <parameter>table_name</parameter> acceptent des masques de recherche + ('%' pour remplacer zéro ou plus caractères, et '_' pour n'en remplacer + qu'un seul). + </para> + <simpara> + Voir aussi <function>odbc_columnprivileges</function> pour connaître les + droits associés. + </simpara> + </refsect1> + </refentry> + <refentry id="function.odbc-columnprivileges"> + <refnamediv> + <refname>odbc_columnprivileges</refname> + <refpurpose> + Liste les colonnes et leurs droits associés + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>odbc_columnprivileges</function></funcdef> + <paramdef>int <parameter>connection_id</parameter></paramdef> + <paramdef>string <parameter><optional>qualifier</optional></parameter></paramdef> + <paramdef>string <parameter><optional>owner</optional></parameter></paramdef> + <paramdef>string <parameter><optional>table_name</optional></parameter></paramdef> + <paramdef>string <parameter><optional>column_name</optional></parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>odbc_columnprivileges</function> liste les colonnes + et leurs droits associés pour la table <parameter>table_name</parameter>. + Retourne un identifiant de résultat ODBC, ou bien FALSE en cas d'erreur. + </para> + <para> + Le résultat possède les colonnes suivantes : + <itemizedlist> + <listitem><simpara>TABLE_QUALIFIER</simpara></listitem> + <listitem><simpara>TABLE_OWNER</simpara></listitem> + <listitem><simpara>TABLE_NAME</simpara></listitem> + <listitem><simpara>GRANTOR</simpara></listitem> + <listitem><simpara>GRANTEE</simpara></listitem> + <listitem><simpara>PRIVILEGE</simpara></listitem> + <listitem><simpara>IS_GRANTABLE</simpara></listitem> + </itemizedlist> + </para> + <simpara> + Le résultat est ordonné par TABLE_QUALIFIER, TABLE_OWNER et + TABLE_NAME. + </simpara> + <para> + Le paramètre <parameter>column_name</parameter> accepte + des masques de recherche ('%' pour remplacer zéro ou plus caractères, + et '_' pour n'en remplacer qu'un seul). + </para> + </refsect1> + </refentry> + <refentry id="function.odbc-gettypeinfo"> + <refnamediv> + <refname>odbc_gettypeinfo</refname> + <refpurpose> + Liste les types de données supportés par une source + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>odbc_gettypeinfo</function></funcdef> + <paramdef>int <parameter>connection_id</parameter></paramdef> + <paramdef>int <parameter><optional>data_type</optional></parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>odbc_gettypeinfo</function> liste les types de données + qui sont supportées par une source. Retourne un identifiant de + résultat, ou FALSE en cas d'erreur. L'argument optionel + <parameter>data_type</parameter> peut être utilisé pour + restreindre les informations à un seul type de données. + </para> + <para> + Le résultat possède les colonnes suivantes : + <itemizedlist> + <listitem><simpara>TYPE_NAME</simpara></listitem> + <listitem><simpara>DATA_TYPE</simpara></listitem> + <listitem><simpara>PRECISION</simpara></listitem> + <listitem><simpara>LITERAL_PREFIX</simpara></listitem> + <listitem><simpara>LITERAL_SUFFIX</simpara></listitem> + <listitem><simpara>CREATE_PARAMS</simpara></listitem> + <listitem><simpara>NULLABLE</simpara></listitem> + <listitem><simpara>CASE_SENSITIVE</simpara></listitem> + <listitem><simpara>SEARCHABLE</simpara></listitem> + <listitem><simpara>UNSIGNED_ATTRIBUTE</simpara></listitem> + <listitem><simpara>MONEY</simpara></listitem> + <listitem><simpara>AUTO_INCREMENT</simpara></listitem> + <listitem><simpara>LOCAL_TYPE_NAME</simpara></listitem> + <listitem><simpara>MINIMUM_SCALE</simpara></listitem> + <listitem><simpara>MAXIMUM_SCALE</simpara></listitem> + </itemizedlist> + </para> + <simpara>Le résultat est ordonné par DATA_TYPE et TYPE_NAME. + </simpara> + </refsect1> + </refentry> + <refentry id="function.odbc-primarykeys"> + <refnamediv> + <refname>odbc_primarykeys</refname> + <refpurpose> + Liste les colonnes utilisées dans une clé primaire + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>odbc_primarykeys</function></funcdef> + <paramdef>int <parameter>connection_id</parameter></paramdef> + <paramdef>string <parameter>qualifier</parameter></paramdef> + <paramdef>string <parameter>owner</parameter></paramdef> + <paramdef>string <parameter>table</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>odbc_primarykeys</function> liste les colonnes + utilisées dans une clé primaire de la table <parameter>table</parameter>. + Retourne un identifiant de résultat, ou FALSE en cas d'erreur. + </para> + <para> + Le résultat possède les colonnes suivantes : + <itemizedlist> + <listitem><simpara>TABLE_QUALIFIER</simpara></listitem> + <listitem><simpara>TABLE_OWNER</simpara></listitem> + <listitem><simpara>TABLE_NAME</simpara></listitem> + <listitem><simpara>COLUMN_NAME</simpara></listitem> + <listitem><simpara>KEY_SEQ</simpara></listitem> + <listitem><simpara>PK_NAME</simpara></listitem> + </itemizedlist> + </para> + </refsect1> + </refentry> + <refentry id="function.odbc-foreignkeys"> + <refnamediv> + <refname>odbc_foreignkeys</refname> + <refpurpose> + Liste les clés étrangères + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>odbc_foreignkeys</function></funcdef> + <paramdef>int <parameter>connection_id</parameter></paramdef> + <paramdef>string <parameter>pk_qualifier</parameter></paramdef> + <paramdef>string <parameter>pk_owner</parameter></paramdef> + <paramdef>string <parameter>pk_table</parameter></paramdef> + <paramdef>string <parameter>fk_qualifier</parameter></paramdef> + <paramdef>string <parameter>fk_owner</parameter></paramdef> + <paramdef>string <parameter>fk_table</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>odbc_foreignkeys</function> liste les clés étrangèes + utilisées dans la table <parameter>pk_table</parameter>. + Retourne un identifiant de résultat, ou FALSE en cas d'erreur. + </para> + <para> + Le résultat possède les colonnes suivantes : + <itemizedlist> + <listitem><simpara>PKTABLE_QUALIFIER</simpara></listitem> + <listitem><simpara>PKTABLE_OWNER</simpara></listitem> + <listitem><simpara>PKTABLE_NAME</simpara></listitem> + <listitem><simpara>PKCOLUMN_NAME</simpara></listitem> + <listitem><simpara>FKTABLE_QUALIFIER</simpara></listitem> + <listitem><simpara>FKTABLE_OWNER</simpara></listitem> + <listitem><simpara>FKTABLE_NAME</simpara></listitem> + <listitem><simpara>FKCOLUMN_NAME</simpara></listitem> + <listitem><simpara>KEY_SEQ</simpara></listitem> + <listitem><simpara>UPDATE_RULE</simpara></listitem> + <listitem><simpara>DELETE_RULE</simpara></listitem> + <listitem><simpara>FK_NAME</simpara></listitem> + <listitem><simpara>PK_NAME</simpara></listitem> + </itemizedlist> + </para> + <simpara> + Si <parameter>pk_table</parameter> contient un nom de table, + <function>odbc_foreignkeys</function> retourne la clé primaire + de la table <parameter>pk_table</parameter>, et toutes les + clés étrangères qui y font référence. + </simpara> + <simpara> + Si <parameter>fk_table</parameter> contient un nom de table, + <function>odbc_foreignkeys</function> retourne la liste des + clés étrangères de la table <parameter>fk_table</parameter>, + et les clés primaires (d'autres tables) qui y font référence. + </simpara> + <simpara> + Si <parameter>pk_table</parameter> et + <parameter>fk_table</parameter> contiennent des noms de tables, + <function>odbc_foreignkeys</function> retourne la liste des clés + étrangères de la table <parameter>fk_table</parameter> qui utilisent + la clé primaire de la table <parameter>pk_table</parameter>. + Cette liste devrait ne contenir qu'une clé au mieux. + </simpara> + </refsect1> + </refentry> + <refentry id="function.odbc-procedures"> + <refnamediv> + <refname>odbc_procedures</refname> + <refpurpose> + Liste les procédure stockées + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>odbc_procedures</function></funcdef> + <paramdef>int <parameter>connection_id</parameter></paramdef> + <paramdef>string <parameter><optional>qualifier</optional></parameter></paramdef> + <paramdef>string <parameter><optional>owner</optional></parameter></paramdef> + <paramdef>string <parameter><optional>name</optional></parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>odbc_procedures</function> liste toutes les procédures + stockées dans la source de données. Retourne un identifiant de + résultat, ou FALSE en cas d'erreur. + </para> + <para> + Le résultat possède les colonnes suivantes : + <itemizedlist> + <listitem><simpara>PROCEDURE_QUALIFIER</simpara></listitem> + <listitem><simpara>PROCEDURE_OWNER</simpara></listitem> + <listitem><simpara>PROCEDURE_NAME</simpara></listitem> + <listitem><simpara>NUM_INPUT_PARAMS</simpara></listitem> + <listitem><simpara>NUM_OUTPUT_PARAMS</simpara></listitem> + <listitem><simpara>NUM_RESULT_SETS</simpara></listitem> + <listitem><simpara>REMARKS</simpara></listitem> + <listitem><simpara>PROCEDURE_TYPE</simpara></listitem> + </itemizedlist> + </para> + <para> + Les paramètres <parameter>owner</parameter> et <parameter>name</parameter> + acceptent des masques de recherche ('%' pour remplacer zéro ou + plus caractères, et '_' pour n'en remplacer qu'un seul). + </para> + </refsect1> + </refentry> + <refentry id="function.odbc-procedurecolumns"> + <refnamediv> + <refname>odbc_procedurecolumns</refname> + <refpurpose> + Liste les paramètres des procédures + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>odbc_procedurecolumns</function></funcdef> + <paramdef>int <parameter>connection_id</parameter></paramdef> + <paramdef>string <parameter><optional>qualifier</optional></parameter></paramdef> + <paramdef>string <parameter><optional>owner</optional></parameter></paramdef> + <paramdef>string <parameter><optional>proc</optional></parameter></paramdef> + <paramdef>string <parameter><optional>column</optional></parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>odbc_procedurecolumns</function> list les paramètres + d'entrée et de sortie, ainsi que les colonnes utilisées dans les procédures + désignées par les paramètres. Retourne un identifiant de résultat, ou + FALSE en cas d'erreur. + </para> + <para> + Le résultat possède les colonnes suivantes : + <itemizedlist> + <listitem><simpara>PROCEDURE_QUALIFIER</simpara></listitem> + <listitem><simpara>PROCEDURE_OWNER</simpara></listitem> + <listitem><simpara>PROCEDURE_NAME</simpara></listitem> + <listitem><simpara>COLUMN_NAME</simpara></listitem> + <listitem><simpara>COLUMN_TYPE</simpara></listitem> + <listitem><simpara>DATA_TYPE</simpara></listitem> + <listitem><simpara>TYPE_NAME</simpara></listitem> + <listitem><simpara>PRECISION</simpara></listitem> + <listitem><simpara>LENGTH</simpara></listitem> + <listitem><simpara>SCALE</simpara></listitem> + <listitem><simpara>RADIX</simpara></listitem> + <listitem><simpara>NULLABLE</simpara></listitem> + <listitem><simpara>REMARKS</simpara></listitem> + </itemizedlist> + </para> + <simpara>Le résultat est ordonné par PROCEDURE_QUALIFIER, PROCEDURE_OWNER, + PROCEDURE_NAME et COLUMN_TYPE. + </simpara> + <para> + Les paramètres <parameter>owner</parameter>, <parameter>proc</parameter> et + <parameter>column</parameter> acceptent des masques de recherche + ('%' pour remplacer zéro ou plus caractères, et '_' pour n'en + remplacer qu'un seul). + </para> + </refsect1> + </refentry> + <refentry id="function.odbc-specialcolumns"> + <refnamediv> + <refname>odbc_specialcolumns</refname> + <refpurpose> + Retourne l'ensemble optimal de colonnes, qui permettent de + définir uniquement une ligne dans une table + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>odbc_specialcolumns</function></funcdef> + <paramdef>int <parameter>connection_id</parameter></paramdef> + <paramdef>int <parameter>type</parameter></paramdef> + <paramdef>string <parameter>qualifier</parameter></paramdef> + <paramdef>string <parameter>owner</parameter></paramdef> + <paramdef>string <parameter>table</parameter></paramdef> + <paramdef>int <parameter>scope</parameter></paramdef> + <paramdef>int <parameter>nullable</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <simpara> + Lorsque le <parameter>type</parameter> est SQL_BEST_ROWID, + <function>odbc_specialcolumns</function> + retourne la ou les colonnes qui permettent de repérer uniquement + chaque ligne d'une table. + </simpara> + <simpara> + Lorsque le type <parameter>type</parameter> est SQL_ROWVER, + <function>odbc_specialcolumns</function> retourne l'ensemble + optimal de colonne tel qu'en lisant les valeurs de ces colonnes, + on puisse spécifier n'importe quelle ligne de manière unique. + </simpara> + <simpara> + Retourne un identifiant de résultat, ou FALSE en cas d'erreur. + </simpara> + <para> + Le résultat possède les colonnes suivantes : + <itemizedlist> + <listitem><simpara>SCOPE</simpara></listitem> + <listitem><simpara>COLUMN_NAME</simpara></listitem> + <listitem><simpara>DATA_TYPE</simpara></listitem> + <listitem><simpara>TYPE_NAME</simpara></listitem> + <listitem><simpara>PRECISION</simpara></listitem> + <listitem><simpara>LENGTH</simpara></listitem> + <listitem><simpara>SCALE</simpara></listitem> + <listitem><simpara>PSEUDO_COLUMN</simpara></listitem> + </itemizedlist> + </para> + <simpara> + Le résultat est ordonné par SCOPE. + </simpara> + </refsect1> + </refentry> + <refentry id="function.odbc-statistics"> + <refnamediv> + <refname>odbc_statistics</refname> + <refpurpose>Calcule des statistiques sur une table</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>odbc_statistics</function></funcdef> + <paramdef>int <parameter>connection_id</parameter></paramdef> + <paramdef>string <parameter>qualifier</parameter></paramdef> + <paramdef>string <parameter>owner</parameter></paramdef> + <paramdef>string <parameter>table_name</parameter></paramdef> + <paramdef>int <parameter>unique</parameter></paramdef> + <paramdef>int <parameter>accuracy</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>odbc_statistics</function> effectue quelques statistiques + sur une tables et ses index. Retourne un identifiant de + résultat, ou FALSE en cas d'erreur. + </para> + <para> + Le résultat possède les colonnes suivantes : + <itemizedlist> + <listitem><simpara>TABLE_QUALIFIER</simpara></listitem> + <listitem><simpara>TABLE_OWNER</simpara></listitem> + <listitem><simpara>TABLE_NAME</simpara></listitem> + <listitem><simpara>NON_UNIQUE</simpara></listitem> + <listitem><simpara>INDEX_QUALIFIER</simpara></listitem> + <listitem><simpara>INDEX_NAME</simpara></listitem> + <listitem><simpara>TYPE</simpara></listitem> + <listitem><simpara>SEQ_IN_INDEX</simpara></listitem> + <listitem><simpara>COLUMN_NAME</simpara></listitem> + <listitem><simpara>COLLATION</simpara></listitem> + <listitem><simpara>CARDINALITY</simpara></listitem> + <listitem><simpara>PAGES</simpara></listitem> + <listitem><simpara>FILTER_CONDITION</simpara></listitem> + </itemizedlist> + </para> + <simpara> + Le résultat est ordonné par NON_UNIQUE, TYPE, INDEX_QUALIFIER, + INDEX_NAME et SEQ_IN_INDEX. + </simpara> + </refsect1> + </refentry> + </reference> +