Rodolphe Jouannet
20/11/2002
Version 1.5.5.2 (MySQL)
Version 1.0.0.0 (PostgreSQL)
Ce document utilise un certain nombre de conventions typographiques afin de permettre une meilleure compréhension des membres, méthodes et paramètres à utiliser dans la classe à étudier. Ces conventions sont les suivantes :
La classe c_mySQL4WD() permet un acces natif à une base MySQL (version
3.22.24 ou ultérieure) depuis une application Windev 5.5 ou Windev
7. Elle est composée de deux éléments : une librairie (DLL) développée
en C et une classe Windev. Son utilisation nécessite deux librairies
windows : « mySQL4WD.DLL » (fournie par ce projet) et « LIBMYSQL.DLL »
(fournie par mySQL).
La classe c_postgreSQL4WD() permet un acces natif à une base PostgreSQL
(version 7.2 ou ultérieure - pas testée sur des version plus ancienne)
depuis une application Windev 7. Elle est composée de deux éléments
: une librairie (DLL) développée en C et une classe Windev. Son utilisation
nécessite deux librairies windows : « postgreSQL4WD.DLL » et « LIBPQ.DLL »
(fournies par ce projet).
ATTENTION : cette version hérite de la classe c_log4WD(). Vous devez donc obligatoirement installer cette classe.
Permet de savoir si la fin de la sélection est atteinte ou non.
Utiliser par la méthode mySQLConnecte(). C'est le mode de connection par défaut.
Ce membre est une constante, donc passée entre parenthèse (passe par valeur).
Utiliser par la méthode mySQLConnecte() afin de permettre la compression des données entre le client et le serveur lors de l'utilisation d'une ligne à faible débit.
Ce membre est une constante, donc passée entre parenthèse (passe par valeur).
Utiliser par la méthode mySQLTransaction() afin de débuter une transaction.
Ce membre est une constante, donc passée entre parenthèse (passe par valeur).
Utiliser par la méthode mySQLTransaction() afin de clore une transaction.
Ce membre est une constante, donc passée entre parenthèse (passe par valeur).
Utiliser par la méthode mySQLTransaction() afin d'annuler une transaction.
Ce membre est une constante, donc passée entre parenthèse (passe par valeur).
Permet de créer un moniteur SQL traçant les requêtes envoyées au serveur. Les sorties générées par le moniteur sont envoyées au debugger installé sur le système (Visual C++, debugger système ou le programme DebugView que l'on trouve sur le serveur Unix).
Ce membre peut recevoir une valeur booléenne (Vrai ou Faux).
Initialise la classe c_mySQL4WD() ou c_postgreSQL4WD(). En fait, cette méthode charge la librairie « mySQL4WD.DLL » ou « postgreSQL.DLL »en mémoire.
Cette méthode ne retourne aucune information.
Clos l'instance de cette classe. Elle libère le fichier « mySQL4WD.DLL » ou « postgreSQL.DLL » chargé en mémoire.
Cette méthode ne retourne aucune information.
Permet de bloquer les enregistrements retournés par la requête (lock à la ligne - ne fonctionne qu'avec le support de table InnoDB pour MySQL et fonctionne en natif avec postgreSQL). La requête passée en paramètre n'est pas fermée.
Cette méthode retourne un booléen.
Permet la connection à la base de donnée. Les paramètres sont les suivants :
Formate la date passée en paramètre dans un format compatible avec SQL.
Cette méthode retourne une chaine de caractères.
Déconnecte la session en cours et libère l'instance du serveur SQL. Les requêtes restants en instance sont automatiquement fermées.
Cette méthode ne retourne aucune information.
Envoie la requête passée en paramètre au moteur de base de donnée SQL. La requête est alors exécutée et le résultat est retourné au client. NumRequete permet d'identifier la requête (attention, on ne peut pas identifier plus de 5 requêtes différentes en même temps - utiliser pour cela mySQLFerme() et réutilisé le numéro d'identifiant libéré). La valeur de NumRequete est testée dans cette fonction, elle doit être comprise entre 0 et 4 sinon, une message d'erreur est renvoyé.
Cette méthode retourne un booléen.
Permet de libérer les ressources utilisées lors de l'appel à la méthode mySQLExec(). Il est obligatoire d'appeler cette méthode après chaque mySQLExec() même si la requête a retournée un code d'erreur. NumRequete permet d'identifier la requête.
Cette méthode ne retourne aucune information.
Permet de se positionner sur le premier enregistrement de la requête exécutée par mySQLExec(). Cette fonction ne récupère qu'un enregistrement (tuple) à la fois, ce qui évite l'utilisation des ressources machine. Cependant, il n'est pas conseillé d'utiliser mySQLFetch() pour des traitements longs sur les enregistrements (en effet, les enregistrements liés à la requête sont lockés même s'ils ne sont pas encore en mémoire). NumRequete permet d'identifier la requête.
Cette méthode retourne un booléen tant qu'il reste des enregistrements à lire.
Permet de récupérer le message d'erreur SQL.
Cette méthode retourne une chaine de caractères.
Permet de récuper le nombre d'enregistrements retourné par une requête. Cette fonction ne s'utilise qu'après un mySQLPremier() et ne peut s'appliquer à une requête de type fetch. NumRequete permet d'identifier la requête.
Cette méthode retourne un entier long.
Permet de récupérer la valeur du numéro de champs passé en paramètre (correspond au numéro d'ordre dans la requête SQL). NumRequete permet d'identifier la requête[+].
Cette méthode retourne une chaine de caractères.
Permet de récupérer la valeur du champs passé en paramètre (correspond au nom du champs renseigné dans la requête SQL). NumRequete permet d'identifier la requête.
Cette méthode retourne une chaine de caractères.
Permet de récupérer le contenu d'un champs BLOB (binaire ou texte) dans le champs passé en paramètre (en général un champs de type image, le nom d'un bouton, d'un onglet, ...). NumRequete permet d'identifier la requête. NumChamps permet d'identifer le numéro du champs BLOB concerné. NomChamps permet d'identifier le champs Windev à renseigner.
Cette méthode ne retourne aucune information.
Permet de se positionner sur le premier enregistrement de la requête exécutée par mySQLExec(). S'il n'y a pas d'enregistrement, le membre mySQLEnDehors est positionné à vrai. NumRequete permet d'identifier la requête.
Cette méthode ne retourne aucune information.
Renvoie la chaine de caractère passée en paramètre entre simple quote. Cette fonction doit être utilisée lors de l'utilisation de la clause WHERE.
Cette méthode retourne une chaine de caractères.
Permet d'activer le mode AUTOCOMMIT (autoCommitMode = vrai) ou de le désactiver (auCommitMode = faux). Cette méthode n'est utilisée que dans le cadre du mode transactionnel. NumRequete permet d'identifier la requête.
Cette méthode ne retourne aucune information.
Permet de se positionner sur l'enregistrement suivant. Si la fin de la sélection est atteinte, le membre mySQLEnDehors passe à vrai sinon il passe à faux. NumRequete permet d'identifier la requête.
Cette méthode ne retourne aucune information.
Permet de renseigner le contenu de la table nomTable avec le contenu de la requête identifiée par numRequete. Il est nécessaire que la table nomTable contienne le même nombre de colonne que la requête ne retourne de champs (elle peut aussi en contenir plus). NumRequete permet d'identifier la requête.
Cette méthode ne retourne aucune information.
Permet de débuter (membre mySQLDebut), de clore (membre mySQLFin) ou d'annuler (membre mySQLAnnule) une transaction. Cette méthode ne fonctionne qu'avec le support de table InnoDB pour MySQL et fonctionne en natif pour PostgreSQL. NumRequete permet d'identifier la requête.
Cette méthode retourne un booléen.
Permet de gérer le mode transactionnel pour les tables de type InnoDB pour MySQL et fonctionne en natif pour PostgreSQL. Si mode est à faux, la variable AUTOCOMMIT = 0. Si mode est à vrai, la variable AUTOMMIT = 1. NumRequete permet d'identifier la requête.
Cette méthode ne retourne aucune information.
Permet de tester la connection au serveur MySQL. Si la connection est tombée, mySQLPing() tente de reconnecter le poste client. Cette méthode n'est pas utilisée par PostgreSQL.
Cette méthode ne retourne aucune information.
Permet d'afficher un message d'erreur clair. Il allie le message d'erreur passé dans chaine et le message d'erreur renvoyé par le serveur SQL.
Cette méthode ne retourne aucune information.
Permet de se positionner sur le dernier enregistrement de la requête exécutée par mySQLExec(). S'il n'y a pas d'enregistrement, le membre mySQLEnDehors est positionné à vrai. NumRequete permet d'identifier la requête.
Cette méthode ne retourne aucune information.
Permet de se positionner sur l'enregistrement précédent. Si le début de la sélection est atteinte, le membre mySQLEnDehors passe à vrai sinon il passe à faux. NumRequete permet d'identifier la requête.
Cette méthode ne retourne aucune information.
Formate la chaine de caractères passée en paramètre afin d'être compatible avec le format des chaines de caractères du moteur SQL (en fait, elle double les simples quotes incluses dans la chaine, et insère des caractères d'échappement en cas de besoin. Elle retourne la chaine ainsi constituée encadrée par des simples quotes). Cette fonction est obligatoire lors d'appel aux commande INSERT et UPDATE.
Cette méthode retourne une chaine de caractères.