Configuring Drivers

In most cases, creating new connection is pretty straightforward process. But if you:

  • Want to work with different versions of the DBMS client libraries in different connections, established simultaneously
  • Want to choose an explicit version of the client library (for instance, to use one of many LIBMYSQL.DLLs installed on the workstation)
  • Want to set up drivers that require parameters to be specified, like MySQL Embedded server
  • Have no installed client libraries, but have those as portable (folder of DLLs)
  • Have issues while you’re trying to establish connection

 – then you should configure a driver. In general, the process consists of:

  • Specifying base driver.
  • Specifying path to client library.
  • Setting up additional parameters, if needed.

Click Configure button to open driver configuration file:

configure driver

This is a simple INI file, where

  • sections in square brackets highlighted with red – names of your configured (or so called “virtual“) drivers. Choose it by your flavor (for instance, specifying DBMS version)
  • BaseDriverID key value – code of standard (base, or parent) driver
  • VendorLib with platform suffix – full path to the client library

After you added your virtual driver, click Save button, then select it in the Driver drop-down list and click Test Connection to check if driver configuration was successful:

virtual driver

Driver Configuration Parameters

The following parameters can be specified:

Parameter Description Applied to Drivers
VendorLib[ | Win32 | Win64 | MacOS32 | MacOS64 | UIX32 | UIX64] The DBMS client software API DLL name. For example: libmysql510.dll. Oracle
PostgreSQL
Firebird/Interbase
MySQL
VendorHome[ | Win32 | Win64 | MacOS32 | MacOS64 | UIX32 | UIX64] The Oracle Home name. Oracle
The base installation path. For example: C:\ib\ib2007. Interbase
The base installation path for a normal server. For example: C:\MySQL\MySQL5-1-7. Or the path to LIBMYSQLD.DLL for an embedded server. For example C:\MyAPP\MySQL. MySQL
ODBCDriver ODBC driver name. For example: Adaptive Server Anywhere 8.0. All ODBC based
ODBCAdvanced ODBC driver additional parameters. The string consists of ODBC driver parameters separated by semicolon. For possible values, check the vendor documentation. All ODBC based
EmbeddedArgs MySQL embedded server arguments. The string consists of MySQL server arguments separated by semicolon. For possible values, check the vendor documentation. For example: --datadir=./data;--language=./;--skip-innodb. MySQL
EmbeddedGroups MySQL embedded server configuration file groups. MySQL
NLSLang Oracle NLS_LANG environment variable value. Oracle
TNSAdmin Oracle TNS_ADMIN environment variable value. Oracle

 if the VendorLib is specified (additionally, you may specify a suffix, designating a platform), the app uses the specified library. If the VendorHome is specified, the DLL with default name from the Bin subfolder is used.

Configured Drivers Examples

[Ora815]

; Ora815 virtual driver will use specified Oracle Home

BaseDriverID=Ora
VendorHomeWin32=OraHome815
VendorHomeWin64=OraHome815_64

[MySQL327]

; MySQL327 virtual driver will use specified LIBMYSQL.DLL

BaseDriverID=MySQL
VendorLib=c:\LIBMYSQL327.DLL

[MySQL510_Embedded]

; MySQL510_Embedded virtual driver will use specified MySQL embedded library and arguments

BaseDriverID=MySQL
VendorLib=c:\LIBMYSQLD.DLL
EmbeddedArgs=–datadir=./data;–language=./;–skip-innodb;–skip-networking

[MSSQL_2000]

; MSSQL_2000 virtual driver will use specified ODBC driver

BaseDriverID=MSSQL
ODBCDriver=SQL SERVER

[ASA]

; ASA base driver will use specified ODBC driver

ODBCDriver=Adaptive Server Anywhere 8.0

[FB21]

; FB21 virtual driver will use specified Firebird client library

BaseDriverID=FB
VendorLibWin32=C:\ib\fb21\bin\fbclient.dll
VendorLibWin64=C:\ib\fb21_64\bin\fbclient.dll

[FB21_Embedded]

; FB21_Embedded virtual driver will use specified Firebird client library

BaseDriverID=FB
VendorLib=C:\ib\fb21_embed\bin\fbembed.dll

Available Base Driver Values

Below you can find list of DBMSes and their corresponding BaseDriverID value:

DBMS BaseDriverId
Oracle Ora
MySQL MySQL
MS SQL Server MSSQL
PostgreSQL PG
MongoDB Mongo
SQLite SQLite
IBM DB2 DB2
IBM Informix Infx
MS Access MSAcc
Teradata TData
SAP Advantage DB Server ADS
SAP SQL Anywhere ASA
Firebird FB
InterBase IB
IBLite IBLite
NexusDB Nexus
DataSnap DS
TDBX TDBX
ODBC ODBC
Scroll to Top