ODBCConn/fr

From Free Pascal wiki
Jump to: navigation, search

English (en) español (es) français (fr)

Portail de la base de données

Références:

Tutoriels/articles pratiques :

Bases de données

Advantage - MySQL - MSSQL - Postgres - Interbase - Firebird - Oracle - ODBC - Paradox - SQLite - dBASE - MS Access - Zeos

L'unité ODBCConn implémente une connexion SQLdb pour ouvrir des sources de données Open Database Connectivity (ODBC).

Vue d'ensemble

ODBC

ODBC (Open Database Connectivity) est une technologie qui permet à chacun de se connecter à une variété de base de données en utilisant une simple API, l'API ODBC.

Il y a des implémentations ODBC pour des plates-formes diverses et il y a des pilotes pour la plupart des SGBDR. La documentation officielle ODBC peut être trouvée dans le site ODBC de MSDN.

TODBCConnection

FreePascal est livré avec des en-têtes ODBC; Ils se trouvent dans les unités odbcsql et odbcsqldyn.

TODBCConnection est un descendant de TSQLConnection fournissant une enveloppe POO sympa pour ODBC en utilisant le framework SQLdb.

Dans Lazarus, vous pouvez trouver le composant TODBCConnection dans l'onglet SQLdb. Vous pouvez aussi utiliser le composant TODBCConnection dans votre code en ajoutant l'unité ODBCConn à votre clause uses.

sqldbcomponents.png

Ce qui a été implémenté :

  • Exécution des requêtes et récupération des ensembles résultats.
  • la plupart des types de champ, y compris les BLOB.
  • Les paramètres de requêtes (types string et integer).
  • La préparation des requêtes.
  • UpdateIndexDefs (vous pouvez aussi utiliser ApplyUpdates).

Ce qui reste à implémenter :

  • Support approprié aux transactions; Actuellement, chaque connexion correspond à une transaction.
  • Quelques types de champ :
    • SQL_TYPE_UTC* (ceux-ci sont mentionnés dans les doc ODBC, mais en semble pas utilisées dans les implémentions).
    • SQL_INTERVAL_* (quel pourrait être le TFieldType correspondant ?)
    • SQL_GUID (TGUIDField n'était pas implémenté, jusqu'à récemment).

Pourquoi utiliser ODBC?

Free Pascal est livré avec des composants pour la connexion à plusieurs bases de données, telles que MySQL, PostGreSQL, Firebird, Microsoft SQL Server (depuis 2.6.1), Oracle, etc.

Pour les bases de données manquantes à la liste, comme MS Access et peut-être Microsoft SQL Server, Microsoft SQL Server, EDBC est une solution acceptable et bien établie.

(Il est recommandé aux développeurs VB.net/C# d'utiliser SQLClient plutôt que OLEDB ou ODBC pour une performance optimale, mais ici, Lazarus ODBC fonctionnera de manière adéquate et fiable)

Le composant TODBCConnection a été développé l'origine pour contourner la licence stricte de MySQL pour les applications qui ne sont pas GPL-isées ou qui n'obéissent pas à MySQL AB exception FLOSS.

Installation d'ODBC des des pilotes ODBC

Avant de pouvoir vous connecter à votre base de données en utilisant ODBC, vous avez besoin d'installer :

  • un gestionnaire de pilotes ODBC
  • un ilote spécifique au SGBD auquel vous voulez vous connecter.

Cette section bous donnera une brève vue d'ensemble des étapes impliquées. Toutefois, veuillez consulter la documentation pertinente pour une référence définitive.

Le gestionnaire de pilotes ODBC

Windows

windows a un gestionnaire de pilotes ODBC intégré, qui permet le réglages des DSNs et d'autres configurations. Il est accessible depuis le Panneau de contrôle, dans les versions récentes avec des sections catégorisées, il a été déplacé dans l'aire Outils d'administration. Vous pouvez aussi cliquer sur le bouton Démarrer et entrer ODBC dans la boîte d'exécution (dans Windows 7, ceci apparaît comme "Rechercher des programmes et des fichiers").

Vous pouvez, bien sûr, créer un raccourci de bureau vers la boîte de dialogue si vous pensez l'utiliser régulièrement.

WinXPODBCDataSourceAdministratorDrivers.png

Unix-s

Deux gestionnaires de pilotes ODBC populaires dans les paltes-formes sont unixODBC et iODBC. ODBCConn est connu pour fonctionner avec unixODBC ; La compatibilité iODBC doit encore être testée.

Debian

Pour Debian, vous pouvez installer le paquet unixodbc :1

aptitude install unixodbc
aptitude install unixodbc-bin # if you want some GUI tools

L'unité odbcsqldyn et par conséquent odbcconn, vont chercher un fichier appelé libodbc.so.

Elle n'acceptera pas un fichier nommé libodbc.so.1 ou libodbc.so.1.0.0. Le paquet unixodbc de Debian ne crée pas de lien symbolique (symlink) avec le nom /usr/lib/libodbc.so ; donc vous devez soit :

  • créer le lien vous-même : ln -s libodbc.so.1 /usr/lib/libodbc.so, ou
  • installer le paquet unixodbc-dev, qui crée le lien symbolique.

Si vous avez installé le paquet unixodbc-bin, vous pouvez exécuter le programme ODBCConfig pour configurer les pilotes ODBC et les DSNs.

ODBCDataSourceAdministratorAbout.PNG

Ubuntu

Pour Ubuntu, suivez l'instruction pour Debian. Note : Le paquet unixodbc-bin pourrait ne pas être disponible depuis le référentiel de paquet par défaut.

Pilotes ODBC

Vous pouvez télécharger les derniers pilotes ODBC avec les liens suivants :

Télécharger le pilote ODBC 32/64-bit pour SQL Server - la dernière version du pilote SQL Server ODBC qui prend en charge Windows, Mac OS X, Linux à la fois les versions 32 et 64-bit. Compatible avec SQL Server 2014\2012\2008 R2\ 2008\2005 (y compris la version Express), SQL Server 2000 (y compris MSDE), SQL Server 7, SQL Server Compact 4.0\3.5\3.1. Fonctionne sur toutes les version de Lazarus.

Télécharger le pilote ODBC 32/64-bit pour Oracle - Dernière version du pilote ODBC Oracle qui prend en charge Windows, Mac OS X, Linux à la fois les versions 32 et 64-bit. Compatible avec les serveurs Oracle : 12c, 11g, 10g, 9i, 8i, 8.0, y compris Oracle Express Edition 11g et 10g. Clients Oracle : 12c, 11g, 10g, 9i, 8i, 8.0. Fonctionne sur toutes les versions de Lazarus.

Télécharger le pilote ODBC 32/64 bit pour MySQL - Dernière version du pilote MySQL qui prend en charge Windows, Mac OS X, Linux en versions 32 et 64-bit. Compatible avec le serveurs MySQL : 6.0, 5.6, 5.5, 5.1, 5.0, 4.1, 4.0, et 3.23. MariaDB 5.x. Fonctionne sur toutes les versions de Lazarus.

Télécharger le pilote ODBC 32/64 bit pour PostgreSQL - Dernière version du pilote ODBC pour PostgreSQL qui prend en charge Windows, Mac OS X, Linux en versions 32 et 64-bit. Compatible avec les versions de serveur PostgreSQL depuis 7.1 jusqu'à 9.4. Fonctionne sur toutes les versions de Lazarus.

Télécharger le pilote ODBC 32/64-bit pour SQLite - Dernière version du pilote ODBC pour SQLite ODBC qui prend en charge Windows, Mac OS X, Linux en versions 32 et 64-bit. Compatible avec les versions de SQLite depuis 3.0 et supérieur. Fonctionne sur toutes les versions de Lazarus.

Télécharger le pilote ODBC 32/64-bit pour Firebird - Dernière version du pilote ODBC pour Firebird qui prend en charge Windows, Mac OS X, Linux en versions 32 et 64-bit. Compatible avec les versions 3, 2.x, 1.x de Firebird. Fonctionne sur toutes les versions de Lazarus.

Télécharger le pilote ODBC 32/64-bit pour Interbase - Dernière version du pilote ODBC pour Interbase qui prend en charge Windows, Mac OS X, Linux en versions 32 et 64-bit. Compatible avec toutes les versions d'Interbase. Fonctionne sur toutes les versions de Lazarus.

Télécharger le pilote ODBC 32/64-bit pour SQL Azure - Dernière version du pilote ODBC pour SQL Azure qui prend en charge Windows, Mac OS X, Linux en versions 32 et 64-bit. Compatible avec toutes les versions de SQL Azure. Fonctionne sur toutes les versions de Lazarus.

Connexion à une source de données ODBC

Les paramètres de connexion à une source de données ODBC sont décrits à l'aide d'une chaîne de connexion. C'est une chaîne de la forme NAME=VALUE;NAME=VALUE. TODBCConnection fournit une enveloppe (wrapper) autour de cette chaîne de connexion. Certaines de ses propriétés correspondent à des paires nom-valeur dans la chaîne de connexion et des paramètres personnalisés peuvent être spécifiés dans la propriété Params (qui est une TStrings).

Avant d'aller plus en détail sur cette enveloppe, vous devez d'abord avoir une compréhension basique de comment une source de données ODBC est identifiée.

Connexions ODBC via DSN

Un gestionnaire de pilote ODBC fournit une manière alternative pour créer des raccourcis de DSN pour un jeu de paramètres :

  • DSN (DataSource Name soit Nom de Source de Données) : uns source de données utilisateur ou système, identifiée par un nom unique. Les DSNs peuvent être configurés en utilisant l'administrateur de sources de données d'OBDC ou manuellement en éditant le fichier odbc.ini (ou le registre)
  • Fichier DSN : un fichier qui contient des paramètres de connexion. Un administrateur de de source de données ODBC vous permet en général de créer un fichier de DSNs depuis une IHM.

Les paramètres dans un DSN ou un fichier DSN peuvent toujours être combinés avec des paramètres additionnels dans la chaîne de connexion, par exemple pour spécifier un mot de passe.

En configurant un DSN, les détails de la connexion peuvent être vérifiés fonctionnellement avec la boîte de dialogue de gestion, ensuite, le DSN nommé est tout ce qu'il faut pour utiliser la connexion plus tard. Les détails de connexion sont ainsi découplé de l'application, et seul le nom de DSN est utilisé dans votre logiciel - le DSN agissant comme un intermédiaire.

Un avantage dans l'utilisation d'un DSN nommé est que vous pouvez facilement basculer entre des bases de données en utilisant le gestionnaire ODBC sans modifier votre code. C'est utile dans un logiciel commercial pour tester des bugs en utilisant un nombre de jeux de données de votre client.

Sans DSN

Vous pouvez aussi vous connecter sans employer de DSN, simplement en fournissant tous les détails dans la chaîne de connexion que vous règleriez autrement dans un DSN (pilote, serveur, base de données, détails de la connexion). Cette méthode plus directe évite le besoin de configurer un DSN en installant votre applicaiton sur une nouvelle machine.

La spécification ODBC définit quelques paramètres qui peuvent être utilisés dans une chaîne de connexion :

  • Deux paramètres spéciaux, DSN et FILEDSN, qui permettent à quelqu'un de configurer des paramètres prédéfinis, comme décrit plus haut.
  • Le DRIVER spécifie quel pilote ODBC utiliser. Évidement, c'est un paramètre très important.
  • Les paramètres UID et PWD sont utilisés pour fournir un nom d'utilisateur et son mot de passe.

Tous les autres paramètres dépendent du pilote. Veuillez vous référer à la documentation spécifique du pilote pour apprendre plus au sujet des paramètres disponibles et leurs noms.

Propriétés TODBCConnection

La table suivante décrit la correspondance entre les propriétés de TODBCConnection et les paramètres de chaîne de connexion ODBC :

Propriété Type Paramètre de chaîne de connexion
Driver string DRIVER
DatabaseName string DSN, et non pas quelque chose comme DATABASENAME, qui ne fait pas partie de la norme ODBC.
FileDSN string FILEDSN
Password string PWD
UserName string UID
HostName string none ; Pas de paramètre correspondant dans la norme ODBC.
Params TStrings Utilisez ceci pour spécifier des paramètres personnalisés. Chaque article doit être de la forme NAME=VALUE.

Un paramètre important qui peut être utilisé est AUTOCOMMIT qui détermine si les ordres SQL sont directement exécutés (sans possibilité de Rollback) (règlage par défaut ou mettez-le explicitement en utilisant AUTOCOMMIT=1) ou si vous avez besoin d'appeler manuellement StartTransaction et Commit, CommitRetaining ou Rollback (réglez-le à AUTOCOMMIT=0)

Remarquez que TODBCConnection prendra soin d'échapper les valeurs de paramètres au besoin.

La propriété booléenne LoginPrompt n'est pas encore implémentée. Il faudrait trouver le bon handle de fenêtre, de sorte qu'un pilote peut afficher une boîte de dialogue GUI pour spécifier des paramètres. Notez que cela n'est pas contrôlé par la chaîne de connexion, mais plutôt par le dernier paramètre de la fonction de l'API ODBC SQLDriverConnect.

Exemples

Dans cette section, des exemples sont donnés pour se connecter à certains SGBD en utilisant leur pilote ODBC spécifique.

Connexion à Excel

Ne fonctionne sans doute que sur Windows.

Pour éviter des erreurs comme : Could not start transaction! ODBC error details: LastReturnCode: SQL_ERROR; Record 1: SqlState: HYC00; NativeError: 106; Message: [Microsoft][ODBC Excel Driver]Optional feature not implemented ;

... vous devrez activer l'autocommit, quelque chose comme

ODBCConnection1.Params.Add('AUTOCOMMIT=1');

Connexion à MySQL

Pour une référence sur les paramètres pris en charge par le pilote MyODBC, voyez [1].

De plus, vous pouvez contrôler ce guide de mysql connexion ODBC. Il donne une explication détaillée sur la manière de se connecter à MySQL en utilisant ODBC.

Le nom du pilote diffère un peu selon la plate-forme et la version de MyODBC ; des exemples :

 { properties of connection object, i.e. conn: TODBCConnection; }
 conn.Driver := 'MySQL'; // (Unix) 
 conn.Driver := 'MySQL ODBC 3.51 Driver';  // (Windows)
 conn.Driver := 'MySQL Connector/ODBC v5'; // (Windows)
 // note: driver name doesn't need {} like it does in SQL Connection Strings elsewhere

D'autres paramètres (en n'utilisant pas un DSN) :

 conn.UserName := 'myUsername';
 conn.Password := 'myPassword';
 // conn.Params (TStrings) set using .add method :
 conn.Params.Add('server=example.com');
 conn.Params.Add('port=3306');
 conn.Params.Add('database=myDatabase');
 conn.Params.Add('charset=utf8');

Connexion à MS Access

Veuillez voir MS Access.

Connexion à Microsoft SQL Server

Note-icon.png

Remarque: Les versions plus récentes que FPC 2.6.0 et Lazarus l'utilisant prennent en charge une connexion directe SQLdb vers MS SQL Server ; voir MSSQL

Utilisez ces exemples de connexion au pilote ODBC de MS SQL qui contiennent une tutoriel pas à pas et des chaînes des connexion.

Voir http://www.connectionstrings.com/sql-server#p7 pour plus de détails sur les chaînes de connexion.

Exemple de chaîne de connexion ODBC pour Microsoft SQL Server :

Server=<server name>; // or <server name>\<instance name>
Database=<database name>;

Connexion à Oracle

Utilisez ce guide de connexion ODBC à Oracle pour réaliser facilement et sans souffrance une connexion à Oracle.

Exemple de chaîne de connexion à Oracle :

Login Prompt=False;
Data Source=ORCL;
User ID=scott;
Password=tiger

Connexion à PosgreSQL

Utilisez ce postgresql guide de connexion ODBC à Postgresql pour réaliser facilement et sans souffrance une connexion à PostgreSQL.

Exemple de chaîne de connexion à PostgreSQL :

Login Prompt=False;
Data Source=localhost;
User ID=postgres;
Password=postgres;
Database=postgres;
Schema=public

Connexion à SQLite

Utilisez ce guide de connexion ODBC à SQLite pour réaliser facilement et sans souffrance une connexion à une base de données SQLite.

Exemple de chaîne de connexion à SQLite :

Login Prompt=False;
Database=c:\test.db3

Connexion à Firebird

Utilisez ce guide de connexion ODBC à Firebird pour réaliser facilement et sans souffrance une connexion à une base de données Firebird.

Exemple de chaîne de connexion à Firebird :

Data Source=127.0.0.1;
User ID=sysdba;
Password=masterkey;
Client Library=fbclient.dll;
Database=c:\fbd.fdb

DSN nommé

Sur Windows, vous pouvez utiliser quelque chose comme ceci avec un DSN nommé existant :

 { properties of connection object, i.e. conn: TODBCConnection; }
 conn.DatabaseName := '<Your_DSN_Name>';
 { Leave all other conn. properties empty }

Sans DSN

Ceci devient :

 { properties of connection object, i.e. conn: TODBCConnection; }
 conn.Driver := 'SQL Server';
 // note: driver name doesn't need {} like it does in SQL Connection Strings elsewhere
 { Leave Hostname and DatabaseName properties empty }
 { set conn.Params (TStrings) : }
 conn.Params.Add('Database=<yourdatabasename>');
 conn.Params.Add('Server=.\SQLEXPRESS');
 conn.Params.Add('Trusted_Connection=Yes'); // or 'Integrated Security=SSPI'

Note : Dans cet exemple, nos nous connectons à la machine locale (server=.), à l('instance SQLEXPRESS. Vous pouvez utiliser un nom d'hôte (hostname) à la place et vous pouvez omettre l'instance pour vous connecter à l'instance par défaut. Voyez la documentation MS pour les détails.

Utiliser une connexion de confiance (trusted, aussi connue comme sécurité intégrée ou SSPI) signifie que vous vous connectez en utilisant vos pièces d'identité (credentials) d'utilisateur Windows. Vous pouvez omettre la ligne Trusted_Connection, mais vous devez alors spécifier l'ID utilisateur (Uid=...) et le mot de passe (Pwd=...).

Exemple DSN

L'exemple de code du dessous sélectionne les lignes depuis une table de MS SQL Server appelée 'journal_entries' et affiche toutes les valeurs de la colonne 'journal_entry' dans un contrôle TMemo nommé Memo1.

// uses  ODBCConn, sqldb;
procedure TForm1.Button1Click(Sender: TObject);
var
  S: String;
  conn : TODBCConnection; // uses ODBCConn
  query: TSQLQuery;       // uses sqldb
  transaction: TSQLTransaction;   // uses sqldb
 
begin
  conn := TODBCCOnnection.Create(nil);
  query := TSQLQuery.Create(nil);
  transaction := TSQLTransaction.Create(nil);
  try
    try
      conn.DatabaseName := 'sqlserverdsn'; {replace this with your DSN, if you use any}
      conn.UserName:= 'sa'; //replace with your user name
      conn.Password:= 'thepassword'; //replace with your password
      // You can override the properties defined in the DSN, e.g.
      //conn.Params.Add('Database=some_other_db');
 
      conn.Transaction := transaction;
      query.DataBase := conn;
      { To avoid "could not retrieve primary key metadata":
      - either use query.UsePrimaryKeyAsKey:=false
      or (preferred)
      - query.PacketRecords to -1
      If you are using SQL Server, you could alternatively enable MARS in your SQL Native Client ODBC driver.
      See http://bugs.freepascal.org/view.php?id=13241 }
      query.PacketRecords:=-1; //retrieve all data at once
      query.SQL.Text := 'select journal_entry from journal_entries';
      query.Open;
      S := '';
      while not query.EOF do
      begin
        S := S + query.FieldByName('journal_entry').AsString + #13#10;
        query.Next;
      end;
    finally
      query.Free;
      conn.Free;
      transaction.Free;
    end;
  except
    on E: Exception do
      ShowMessage(E.message);
  end;
  Memo1.Text:= S;
end;

En fait il est possible d'utiliser conn.Params pour toutes les parties de la chaîne de connexion, si vous modifiez ce qui précède - cette fois, en montrant la version de SQL Server dans un message pop-up :

  conn.Params.Add('Driver=SQL Server');
  conn.Params.Add('Server=OURBIGSERVER');
  conn.Params.Add('Database=TestDataBase');
  conn.Params.Add('Integrated Security=SSPI'); // use Windows logon credentials
  // no other conn. properties set, apart from conn.Transaction := transaction;
 
  query.DataBase := conn;
  query.SQL.Text := 'select @@version';
  query.Open;
  showmessage(query.Fields[0].AsString); // Fields are numbered starting from 0

Les fonctions sont prises en charge - p.ex. 'SELECT * FROM MyTestFunc()' - mais il peut y avoir des problèmes avec les procédures stockées qui retourne des ensembles d'enregistrements. Par exemple, si 'EXEC MyStoredProcedure' retourne des lignes de données (vérifié dans le SQL Server Management Studio ou avec la commande DOS : C:\>sqlcmd -S MyServer -E -d MyDataBase -Q "exec MySP") alors query.open nous donnera une erreur : "Cannot open a non-select statement" (cela pourrait être corrigé après FPC 2.6).

Pour appeler une procédure stockées ou pour émettre d'autres ordres SQL qui ne retourne pas d'ensemble de données (CREATE,INSERT,UPDATE,DELETE), utilisez query.ExecSQL au lieu de query.Open.

Les paramètres de procédure stockées fonctionnent, p.ex. 'EXEC MySP @param1=23'.

L'emploi de Paramètres est recommandé pour éviter des vulnérabilités par injection SQL. Dans ce cas, l'ordre SQL n'est pas construit directement avec des valeurs, mais des marques substitutives nommées (named placeholder) sont utilisées à la place - et ensuite les paramètres sont spécifiées séparément. Avec cette méthode, il est impossible d'injecter du code SQL malicieux dans les champs variables pour altérer la base de données ; le serveur sait alors distinguer les instructions des valeurs. Par exemple, au lieu de construire une clause WHERE contenant la valeur 95 ('... WHERE field2>95'), vous utilisez un paramètre nommé tel que 'testval' -

 query.SQL.Text := 'select * from mytable where field2=:testval';
 query.Params.ParamByName('testval').AsString := '95';
 query.open;

Débogage d'ODBC & erreurs

Problèmes avec des transactions

Dans Lazarus 1.2.4 (FPC 2.6.4), le comportement de transaction ODBC a changé. Cela peut rendre du code qui marchait avant en code qui ne marche plus.

Pour une solution, voyez User_Changes_2.6.4#TODBCConnection_.28odbcconn.29_No_longer_autocommit.

Messages d'erreur

Chaque appel à l'API ODBC retourne aussi un code de succès ; s'il y a une erreur, plus d'informations peut être obtenue en faisant des appels à SQLGetDiagRec. Dans un souci d'exhaustivité : les enregistrements de diagnostic sont également disponibles lorsqu'un appel d'API renvoie SQL_SUCCES_WITH_INFO .

TODBCConnection vérifie le code de retour de chaque appel ODBC et construit une EODBCException. Le message de cette exception consiste en :

  • un message identifiant ce que le TODBCConnectionfaisait quand l'erreur s'est produite.
  • Le code de retour de l'appel à l'API ODBC (p.ex. SQL_ERROR)
  • un nombre d'enregistrements de diagnostic (obtenus en utilisant SQLGetDiagRec) ; chaque enregistrement consiste en trois champs :
    • un code d'erreur sur 5 caractères identifiant l'erreur
    • Un "code d'erreur natif"
    • un message décrivant l'erreur

Erreur de fonction séquence

Si vous obtenez une 'Function sequence error' dans la section 'finalization' de l'unité ODBCConn, il s'agit probablement que vous n'avez pas nettoyer correctement toutes vos requêtes et vos connexions.

Le Rollback ne fonctionne pas

Si vous émettez des instructions
TSQLTransaction.Rollback
mais que votre SQL est validé malgré tout, votre connexion est probablement en mode AUTOCOMMIT ; voyez les remarques sur le paramètre de connexion AUTOCOMMIT pour savoir comment corriger ceci.

Tracage

Most ODBC managers have a tracing option in which all ODBC API calls are logged to a trace log. This can be very useful for debugging an ODBC application. The ODBC Data Source Administration GUI of both Windows and unixODBC have a tab where you can configure the tracing option.

Of course the trace log is mainly useful for developers that are familiar with the ODBC API, but it can help to identify the problem. Also, you can attach a trace log if you report a problem to the bug tracker.

Voir aussi

  • MS Access Utilisation de ODBC pour accéder aux bases de données Microsoft Access.