JavaScript Editor Source code editor     What Is Ajax 

Main Page

Chapter 23. Connectors

Table of Contents

23.1. MySQL Connector/ODBC
23.1.1. Introduction to Connector/ODBC
23.1.2. Connector/ODBC Installation
23.1.3. Connector/ODBC Configuration
23.1.4. Connector/ODBC Examples
23.1.5. Connector/ODBC Reference
23.1.6. Connector/ODBC Notes and Tips
23.1.7. Connector/ODBC Support
23.2. MySQL Connector/NET
23.2.1. Connector/NET Versions
23.2.2. Connector/NET Installation
23.2.3. Connector/NET Examples and Usage Guide
23.2.4. Connector/NET Reference
23.2.5. Connector/NET Notes and Tips
23.2.6. Connector/NET Support
23.3. MySQL Visual Studio Plugin
23.3.1. Installing the MySQL Visual Studio Plugin
23.3.2. Creating a connection to the MySQL server
23.3.3. Using the MySQL Visual Studio Plugin
23.3.4. Visual Studio Plugin Support
23.4. MySQL Connector/J
23.4.1. Connector/J Versions
23.4.2. Connector/J Installation
23.4.3. Connector/J Examples
23.4.4. Connector/J (JDBC) Reference
23.4.5. Connector/J Notes and Tips
23.4.6. Connector/J Support
23.5. MySQL Connector/MXJ
23.5.1. Introduction to Connector/MXJ
23.5.2. Connector/MXJ Installation
23.5.3. Connector/MXJ Configuration
23.5.4. Connector/MXJ Reference
23.5.5. Connector/MXJ Notes and Tips
23.5.6. Connector/MXJ Support
23.6. Connector/PHP

This chapter describes MySQL Connectors, drivers that provide connectivity to the MySQL server for client programs. There are currently five MySQL Connectors:

For information on connecting to a MySQL server using other languages and interfaces than those detailed above, including Perl, Python and PHP for other platforms and environments, please refer to the Chapter 22, APIs and Libraries chapter.

23.1. MySQL Connector/ODBC

The MySQL Connector/ODBC is the name for the family of MySQL ODBC drivers (previously called MyODBC drivers) that provide access to a MySQL database using the industry standard Open Database Connectivity (ODBC) API. This reference covers Connector/ODBC 3.51, a version of the API that provides ODBC 3.5x compliant access to a MySQL database.

The manual for versions of Connector/ODBC older than 3.51 can be located in the corresponding binary or source distribution.

For more information on the ODBC API standard and how to use it, refer to

The application development part of this reference assumes a good working knowledge of C, general DBMS knowledge, and finally, but not least, familiarity with MySQL. For more information about MySQL functionality and its syntax, refer to

Typically, you need to install Connector/ODBC only on Windows machines. For Unix and Mac OS X you can use the native MySQL network or named pipe to communicate with your MySQL database. You may need Connector/ODBC for Unix or Mac OS X if you have an application that requires an ODBC interface to communicate with the database. Applications that require ODBC to communicate with MySQL include ColdFusion, Microsoft Office, and Filemaker Pro.

If you want to install the Connector/ODBC connector on a Unix host, then you must also install an ODBC manager.

Key topics:

23.1.1. Introduction to Connector/ODBC

ODBC (Open Database Connectivity) provides a way for client programs to access a wide range of databases or data sources. ODBC is a standardized API that allows connections to SQL database servers. It was developed according to the specifications of the SQL Access Group and defines a set of function calls, error codes, and data types that can be used to develop database-independent applications. ODBC usually is used when database independence or simultaneous access to different data sources is required.

For more information about ODBC, refer to Connector/ODBC Versions

There are currently two version of Connector/ODBC available:

  • Connector/ODBC 5.0, currently in beta status, has been designed to extend the functionality of the Connector/ODBC 3.51 driver and incorporate full support for the functionality in the MySQL 5.0 server release, including stored procedures and views. Applications using Connector/ODBC 3.51 will be compatible with Connector/ODBC 5.0, while being able to take advantage of the new features. Features and functionality of the Connector/ODBC 5.0 driver are not currently included in this guide.

  • Connector/ODBC 3.51 is the current release of the 32-bit ODBC driver, also known as the MySQL ODBC 3.51 driver. This version is enhanced compared to the older Connector/ODBC 2.50 driver. It has support for ODBC 3.5x specification level 1 (complete core API + level 2 features) in order to continue to provide all functionality of ODBC for accessing MySQL.

  • MyODBC 2.50 is the previous version of the 32-bit ODBC driver from MySQL AB that is based on ODBC 2.50 specification level 0 (with level 1 and 2 features). Information about the MyODBC 2.50 driver is included in this guide for the purposes of comparison only.


From this section onward, the primary focus of this guide is the Connector/ODBC 3.51 driver. More information about the MyODBC 2.50 driver in the documentation included in the installation packages for that version. If there is a specific issue (error or known problem) that only affects the 2.50 version, it may be included here for reference.


Version numbers for MySQL products are formatted as X.X.X. However, Windows tools (Control Panel, properties display) may show the version numbers as XX.XX.XX. For example, the official MySQL formatted version number 5.0.9 may be displayed by Windows tools as 5.00.09. The two versions are the same; only the number display format is different. General Information About ODBC and Connector/ODBC

Open Database Connectivity (ODBC) is a widely accepted application-programming interface (API) for database access. It is based on the Call-Level Interface (CLI) specifications from X/Open and ISO/IEC for database APIs and uses Structured Query Language (SQL) as its database access language.

A survey of ODBC functions supported by Connector/ODBC is given at Section, “Connector/ODBC API Reference”. For general information about ODBC, see Connector/ODBC Architecture

The Connector/ODBC architecture is based on five components, as shown in the following diagram:

  • Application:

    The Application uses the ODBC API to access the data from the MySQL server. The ODBC API in turn uses the communicates with the Driver Manager. The Application communicates with the Driver Manager using the standard ODBC calls. The Application does not care where the data is stored, how it is stored, or even how the system is configured to access the data. It needs to know only the Data Source Name (DSN).

    A number of tasks are common to all applications, no matter how they use ODBC. These tasks are:

    • Selecting the MySQL server and connecting to it

    • Submitting SQL statements for execution

    • Retrieving results (if any)

    • Processing errors

    • Committing or rolling back the transaction enclosing the SQL statement

    • Disconnecting from the MySQL server

    Because most data access work is done with SQL, the primary tasks for applications that use ODBC are submitting SQL statements and retrieving any results generated by those statements.

  • Driver manager:

    The Driver Manager is a library that manages communication between application and driver or drivers. It performs the following tasks:

    • Resolves Data Source Names (DSN). The DSN is a configuration string that identifies a given database driver, database, database host and optionally authentication information that enables an ODBC application to connect to a database using a standardized reference.

      Because the database connectivity information is identified by the DSN, any ODBC compliant application can connect to the data source using the same DSN reference. This eliminates the need to separately configure each application that needs access to a given database; instead you instruct the application to use a pre-configured DSN.

    • Loading and unloading of the driver required to access a specific database as defined within the DSN. For example, if you have configured a DSN that connects to a MySQL database then the driver manager will load the Connector/ODBC driver to enable the ODBC API to communicate with the MySQL host.

    • Processes ODBC function calls or passes them to the driver for processing.

  • Connector/ODBC Driver:

    The Connector/ODBC driver is a library that implements the functions supported by the ODBC API. It processes ODBC function calls, submits SQL requests to MySQL server, and returns results back to the application. If necessary, the driver modifies an application's request so that the request conforms to syntax supported by MySQL.

  • DSN Configuration:

    The ODBC configuration file stores the driver and database information required to connect to the server. It is used by the Driver Manager to determine which driver to be loaded according to the definition in the DSN. The driver uses this to read connection parameters based on the DSN specified. For more information, Section 23.1.3, “Connector/ODBC Configuration”.

  • MySQL Server:

    The MySQL database where the information is stored. The database is used as the source of the data (during queries) and the destination for data (during inserts and updates). ODBC Driver Managers

An ODBC Driver Manager is a library that manages communication between the ODBC-aware application and any drivers. Its main functionality includes:

  • Resolving Data Source Names (DSN).

  • Driver loading and unloading.

  • Processing ODBC function calls or passing them to the driver.

Both Windows and Mac OS X include ODBC driver managers with the operating system. Most ODBC Driver Manager implementations also include an administration application that makes the configuration of DSN and drivers easier. Examples and information on these managers, including Unix ODBC driver managers are listed below:

  • Microsoft Windows ODBC Driver Manager (odbc32.dll),

  • Mac OS X includes ODBC Administrator, a GUI application that provides a simpler configuration mechanism for the Unix iODBC Driver Manager. You can configure DSN and driver information either through ODBC Administrator or through the iODBC configuration files. This also means that you can test ODBC Administrator configurations using the iodbctest command.

  • unixODBC Driver Manager for Unix ( See, for more information. The unixODBC Driver Manager includes the Connector/ODBC driver 3.51 in the installation package, starting with version unixODBC 2.1.2.

  • iODBC ODBC Driver Manager for Unix (, see, for more information.

23.1.2. Connector/ODBC Installation

You can install the Connector/ODBC drivers using two different methods, a binary installation and a source installation. The binary installation is the easiest and most straightforward method of installation. Using the source installation methods should only be necessary on platforms where a binary installation package is not available, or in situations where you want to customize or modify the installation process or Connector/ODBC drivers before installation. Where to Get Connector/ODBC

MySQL AB distributes all its products under the General Public License (GPL). You can get a copy of the latest version of Connector/ODBC binaries and sources from the MySQL AB Web site

For more information about Connector/ODBC, visit

For more information about licensing, visit Supported Platforms

Connector/ODBC can be used on all major platforms supported by MySQL. You can install it on:

  • Windows 95, 98, Me, NT, 2000, XP, and 2003

  • All Unix-like Operating Systems, including: AIX, Amiga, BSDI, DEC, FreeBSD, HP-UX 10/11, Linux, NetBSD, OpenBSD, OS/2, SGI Irix, Solaris, SunOS, SCO OpenServer, SCO UnixWare, Tru64 Unix

  • Mac OS X and Mac OS X Server

If a binary distribution is not available for a particular platform, see Section, “Installing Connector/ODBC from a source distribution”, to build the driver from the original source code. You can contribute the binaries you create to MySQL by sending a mail message to , so that it becomes available for other users. Installing Connector/ODBC from a binary distribution

Using a binary distribution offers the most straightforward method for installing Connector/ODBC. If you want more control over the driver, the installation location and or to customize elements of the driver you will need to build and install from the source. See the Section, “Installing Connector/ODBC from a source distribution”. Installing Connector/ODBC from a Binary Distribution on Windows

Before installing the Connector/ODBC drivers on Windows you should ensure that your Microsoft Data Access Components (MDAC) are up to date. You can obtain the latest version from the Microsoft Data Access and Storage Web site.

There are three available distribution types to use when installing for Windows. The contents in each case are identical, it is only the installation method which is different. Installing the Windows Connector/ODBC Driver using an installer

The installer packages offer a very simple method for installing the Connector/ODBC drivers. If you have downloaded the zipped installer then you must extract the installer application. The basic installation process is identical for both installers.

You should follow these steps to complete the installation:

  1. Double click on the standalone installer that you extracted, or the MSI file you downloaded.

  2. The MySQL Connector/ODBC 3.51 - Setup Wizard will start. Click the Next button to begin the installation process.

  • You will need to choose the installation type. The Typical installation provides the standard files you will need to connect to a MySQL database using ODBC. The Complete option installs all the available files, including debug and utility components. It is recommended you choose one of these two options to complete the installation. If choose one of these methods, click Next and then proceed to step 5.

    You may also choose a Custom installation, which enables you to select the individual components that you want to install. You have chosen this method, click Next and then proceed to step 4.

  • If you have chosen a custom installation, use the popups to select which components to install and then click Next to install the necessary files.

  • Once the files have copied to your machine, the installation is complete. Click Finish to exit the installer.

  • Now the installation is complete, you can continue to configure your ODBC connections using Section 23.1.3, “Connector/ODBC Configuration”. Installing the Windows Connector/ODBC Driver using the Zipped DLL package

    If you have downloaded the Zipped DLL package then you must install the individual files required for Connector/ODBC operation manually. Once you have unzipped the installation files, you can either perform this operation by hand, executing each statement individually, or you can use the included Batch file to perform an installation to the default locations.

    To install using the Batch file:

    1. Unzip the Connector/ODBC Zipped DLL package.

    2. Open a Command Prompt.

    3. Change to the directory created when you unzipped the Connector/ODBC Zipped DLL package.

    4. Run Install.bat:

      C:\> Install.bat

      This will copy the necessary files into the default location, and then register the Connector/ODBC driver with the Windows ODBC manager.

    If you want to copy the files to an alternative location - for example, to run or test different versions of the Connector/ODBC driver on the same machine, then you must copy the files by hand. It is however not recommended to install these files in a non-standard location. To copy the files by hand to the default installation location use the following steps:

    1. Unzip the Connector/ODBC Zipped DLL package.

    2. Open a Command Prompt.

    3. Change to the directory created when you unzipped the Connector/ODBC Zipped DLL package.

    4. Copy the library files to a suitable directory. The default is to copy them into the default Windows system directory \Windows\System32:

      C:\> copy lib\myodbc3S.dll \Windows\System32
      C:\> copy lib\myodbc3S.lib \Windows\System32
      C:\> copy lib\myodbc3.dll \Windows\System32
      C:\> copy lib\myodbc3.lib \Windows\System32
    5. Copy the Connector/ODBC tools. These must be placed into a directory that is in the system PATH. The default is to install these into the Windows system directory \Windows\System32:

      C:\> copy bin\myodbc3i.exe \Windows\System32
      C:\> copy bin\myodbc3m.exe \Windows\System32
      C:\> copy bin\myodbc3c.exe \Windows\System32
    6. Optionally copy the help files. For these files to be accessible through the help system, they must be installed in the Windows system directory:

      C:\> copy doc\*.hlp \Windows\System32
    7. Finally, you must register the Connector/ODBC driver with the ODBC manager:

      C:\> myodbc3i -a -d -t"MySQL ODBC 3.51 Driver;\

      You must change the references to the DLL files and command location in the above statement if you have not installed these files into the default location. Handling Installation Errors

    On Windows, you may get the following error when trying to install the older MyODBC 2.50 driver:

    An error occurred while copying C:\WINDOWS\SYSTEM\MFC30.DLL. 
    Restart Windows and try installing again (before running any
    applications which use ODBC)

    The reason for the error is that another application is currently using the ODBC system. Windows may not allow you to complete the installation. In most cases, you can continue by pressing Ignore to copy the rest of the Connector/ODBC files and the final installation should still work. If it doesn't, the solution is to re-boot your computer in “safe mode.” Choose safe mode by pressing F8 just before your machine starts Windows during re-booting, install the Connector/ODBC drivers, and re-boot to normal mode. Installing Connector/ODBC from a Binary Distribution on Unix

    There are two methods available for installing Connector/ODBC on Unix from a binary distribution. For most Unix environments you will need to use the tarball distribution. For Linux systems, there is also an RPM distribution available. Installing Connector/ODBC from a Binary Tarball Distribution

    To install the driver from a tarball distribution (.tar.gz file), download the latest version of the driver for your operating system and follow these steps that demonstrate the process using the Linux version of the tarball:

    shell> su root
    shell> gunzip mysql-connector-odbc-3.51.11-i686-pc-linux.tar.gz
    shell> tar xvf mysql-connector-odbc-3.51.11-i686-pc-linux.tar
    shell> cd mysql-connector-odbc-3.51.11-i686-pc-linux

    Read the installation instructions in the INSTALL-BINARY file and execute these commands.

    shell> cp libmyodbc* /usr/local/lib
    shell> cp odbc.ini /usr/local/etc
    shell> export ODBCINI=/usr/local/etc/odbc.ini

    Then proceed on to Section, “Configuring a Connector/ODBC DSN on Unix”, to configure the DSN for Connector/ODBC. For more information, refer to the INSTALL-BINARY file that comes with your distribution. Installing Connector/ODBC from an RPM Distribution

    To install or upgrade Connector/ODBC from an RPM distribution on Linux, simply download the RPM distribution of the latest version of Connector/ODBC and follow the instructions below. Use su root to become root, then install the RPM file.

    If you are installing for the first time:

    shell> su root
     shell> rpm -ivh mysql-connector-odbc-3.51.12.i386.rpm

    If the driver exists, upgrade it like this:

    shell> su root
    shell> rpm -Uvh mysql-connector-odbc-3.51.12.i386.rpm

    If there is any dependency error for MySQL client library, libmysqlclient, simply ignore it by supplying the --nodeps option, and then make sure the MySQL client shared library is in the path or set through LD_LIBRARY_PATH.

    This installs the driver libraries and related documents to /usr/local/lib and /usr/share/doc/MyODBC, respectively. Proceed onto Section, “Configuring a Connector/ODBC DSN on Unix”.

    To uninstall the driver, become root and execute an rpm command:

    shell> su root
    shell> rpm -e mysql-connector-odbc Installing Connector/ODBC on Mac OS X

    Mac OS X is based on the FreeBSD operating system, and you can normally use the MySQL network port for connecting to MySQL servers on other hosts. Installing the Connector/ODBC driver enables you to connect to MySQL databases on any platform through the ODBC interface. You should only need to install the Connector/ODBC driver when your application requires an ODBC interface. Applications that require or can use ODBC (and therefore the Connector/ODBC driver) include ColdFusion, Filemaker Pro, 4th Dimension and many other applications.

    Mac OS X includes its own ODBC manager, based on the iODBC manager. Mac OS X includes an administration tool that provides easier administration of ODBC drivers and configuration, updating the underlying iODBC configuration files. Installing the Connector/ODBC Driver

    You can install Connector/ODBC on a Mac OS X or Mac OS X Server computer by using the binary distribution. The package is available as a compressed disk image (.dmg) file. To install Connector/ODBC on your computer using this method, follow these steps:

    1. Download the file to your computer and double-click on the downloaded image file.

    2. Within the disk image you will find an installer package (with the .pkg extension). Double click on this file to start the Mac OS X installer.

    3. You will be presented with the installer welcome message. Click the Continue button to begin the installation process.

    4. Please take the time to read the Important Information as it contains guidance on how to complete the installation process. Once you have read the notice and collected the necessary information, click Continue.

    5. Connector/ODBC drivers are made available under the GNU General Public License. Please read the license if you are not familiar with it before continuing installation. Click Continue to approve the license (you will be asked to confirm that decision) and continue the installation.

    6. Choose a location to install the Connector/ODBC drivers and the ODBC Administrator application. You must install the files onto a drive with an operating system and you may be limited in the choices available. Select the drive you want to use, and then click Continue.

    7. The installer will automatically select the files that need to be installed on your machine. Click Install to continue. The installer will copy the necessary files to your machine. A progress bar will be shown indicating the installation progress.

    8. When installation has been completed you will get a window like the one shown below. Click Close to close and quit the installer. Installing Connector/ODBC from a source distribution

    Installing Connector/ODBC from a source distribution gives you greater flexibility in the contents and installation location of the Connector/ODBC components. It also enables you to build and install Connector/ODBC on platforms where a pre-compiled binary is not available.

    Connector/ODBC sources are available either as a downloadable package, or through the revision control system used by the Connector/ODBC developers. Installing Connector/ODBC from a Source Distribution on Windows

    You should only need to install Connector/ODBC from source on Windows if you want to change or modify the source or installation. If you are unsure whether to install from source, please use the binary installation detailed in Section, “Installing Connector/ODBC from a Binary Distribution on Windows”.

    Installing Connector/ODBC from source on Windows requires a number of different tools and packages:

    • MDAC, Microsoft Data Access SDK from

    • Suitable C compiler, such as Microsoft Visual C++ or the C compiler included with Microsoft Visual Studio.

    • Compatible make tool. Microsoft's nmake is used in the examples in this section.

    • MySQL client libraries and include files from MySQL 4.0.0 or higher. (Preferably MySQL 4.0.16 or higher). This is required because Connector/ODBC uses new calls and structures that exist only starting from this version of the library. To get the client libraries and include files, visit Building Connector/ODBC 3.51

    Connector/ODBC source distributions include Makefiles that require the nmake or other make utility. In the distribution, you can find Makefile for building the release version and Makefile_debug for building debugging versions of the driver libraries and DLLs.

    To build the driver, use this procedure:

    1. Download and extract the sources to a folder, then change directory into that folder. The following command assumes the folder is named myodbc3-src:

      C:\> cd myodbc3-src
    2. Edit Makefile to specify the correct path for the MySQL client libraries and header files. Then use the following commands to build and install the release version:

      C:\> nmake -f Makefile
      C:\> nmake -f Makefile install

      nmake -f Makefile builds the release version of the driver and places the binaries in subdirectory called Release.

      nmake -f Makefile install installs (copies) the driver DLLs and libraries (myodbc3.dll, myodbc3.lib) to your system directory.

    3. To build the debug version, use Makefile_Debug rather than Makefile, as shown below:

      C:\> nmake -f Makefile_debug
      C:\> nmake -f Makefile_debug install
    4. You can clean and rebuild the driver by using:

      C:\> nmake -f Makefile clean
      C:\> nmake -f Makefile install


    • Make sure to specify the correct MySQL client libraries and header files path in the Makefiles (set the MYSQL_LIB_PATH and MYSQL_INCLUDE_PATH variables). The default header file path is assumed to be C:\mysql\include. The default library path is assumed to be C:\mysql\lib\opt for release DLLs and C:\mysql\lib\debug for debug versions.

    • For the complete usage of nmake, visit

    • If you are using the Subversion tree for compiling, all Windows-specific Makefiles are named as Win_Makefile*. Testing

    After the driver libraries are copied/installed to the system directory, you can test whether the libraries are properly built by using the samples provided in the samples subdirectory:

    C:\> cd samples
    C:\> nmake -f Makefile all Building MyODBC 2.50

    The MyODBC 2.50 source distribution includes VC workspace files. You can build the driver using these files (.dsp and .dsw) directly by loading them from Microsoft Visual Studio 6.0 or higher. Installing Connector/ODBC from a Source Distribution on Unix

    You need the following tools to build MySQL from source on Unix:

    • A working ANSI C++ compiler. gcc 2.95.2 or later, egcs 1.0.2 or later or egcs 2.91.66, SGI C++, and SunPro C++ are some of the compilers that are known to work.

    • A good make program. GNU make is always recommended and is sometimes required.

    • MySQL client libraries and include files from MySQL 4.0.0 or higher. (Preferably MySQL 4.0.16 or higher). This is required because Connector/ODBC uses new calls and structures that exist only starting from this version of the library. To get the client libraries and include files, visit

      If you have built your own MySQL server and/or client libraries from source then you must have used the --enable-thread-safe-client option to configure when the libraries were built.

      You should also ensure that the libmysqlclient library were built and installed as a shared library.

    • A compatible ODBC manager must be installed. Connector/ODBC is known to work with the iODBC and unixODBC managers. See Section, “ODBC Driver Managers”, for more information.

    • If you are using a character set that isn't compiled into the MySQL client library then you need to install the MySQL character definitions from the charsets directory into SHAREDIR (by default, /usr/local/mysql/share/mysql/charsets). These should be in place if you have installed the MySQL server on the same machine. See Chapter 10, Character Set Support, for more information on character set support.

    Once you have all the required files, unpack the source files to a separate directory, you then have to run configure and build the library using make. Typical configure Options

    The configure script gives you a great deal of control over how you configure your Connector/ODBC build. Typically you do this using options on the configure command line. You can also affect configure using certain environment variables. For a list of options and environment variables supported by configure, run this command:

    shell> ./configure --help

    Some of the more commonly used configure options are described here:

    1. To compile Connector/ODBC, you need to supply the MySQL client include and library files path using the --with-mysql-path=DIR option, where DIR is the directory where MySQL is installed.

      MySQL compile options can be determined by running DIR/bin/mysql_config.

    2. Supply the standard header and library files path for your ODBC Driver Manager (iODBC or unixODBC).

      • If you are using iODBC and iODBC is not installed in its default location (/usr/local), you might have to use the --with-iodbc=DIR option, where DIR is the directory where iODBC is installed.

        If the iODBC headers do not reside in DIR/include, you can use the --with-iodbc-includes=INCDIR option to specify their location.

        The applies to libraries. If they are not in DIR/lib, you can use the --with-iodbc-libs=LIBDIR option.

      • If you are using unixODBC, use the --with-unixODBC=DIR option (case sensitive) to make configure look for unixODBC instead of iODBC by default, DIR is the directory where unixODBC is installed.

        If the unixODBC headers and libraries aren't located in DIR/include and DIR/lib, use the --with-unixODBC-includes=INCDIR and --with-unixODBC-libs=LIBDIR options.

    3. You might want to specify an installation prefix other than /usr/local. For example, to install the Connector/ODBC drivers in /usr/local/odbc/lib, use the --prefix=/usr/local/odbc option.

    The final configuration command looks something like this:

    shell> ./configure --prefix=/usr/local \
             --with-iodbc=/usr/local \
             --with-mysql-path=/usr/local/mysql Additional configure Options

    There are a number of other options that you need, or want, to set when configuring the Connector/ODBC driver before it is built.

    • To link the driver with MySQL thread safe client libraries or libmysqlclient_r.a, you must specify the following configure option:


      and can be disabled (default) using


      This option enables the building of the driver thread-safe library from by linking with MySQL thread-safe client library (The extensions are OS dependent).

      If the compilation with the thread-safe option fails, it may be because the correct thread-libraries on the system could not be located. You should set the value of LIBS to point to the correct thread library for your system.

      LIBS="-lpthread" ./configure ..
    • You can enable or disable the shared and static versions of Connector/ODBC using these options:

    • By default, all the binary distributions are built as non-debugging versions (configured with --without-debug).

      To enable debugging information, build the driver from source distribution and use the --with-debug option when you run configure.

    • This option is available only for source trees that have been obtained from the Subversion repository. This option does not apply to the packaged source distributions.

      By default, the driver is built with the --without-docs option. If you would like the documentation to be built, then execute configure with:

      --with-docs Building and Compilation

    To build the driver libraries, you have to just execute make.

    shell> make

    If any errors occur, correct them and continue the build process. If you aren't able to build, then send a detailed email to for further assistance. Building Shared Libraries

    On most platforms, MySQL does not build or support .so (shared) client libraries by default. This is based on our experience of problems when building shared libraries.

    In cases like this, you have to download the MySQL distribution and configure it with these options:

    --without-server --enable-shared

    To build shared driver libraries, you must specify the --enable-shared option for configure. By default, configure does not enable this option.

    If you have configured with the --disable-shared option, you can build the .so file from the static libraries using the following commands:

    shell> cd mysql-connector-odbc-3.51.01
    shell> make
    shell> cd driver
    shell> CC=/usr/bin/gcc \
              $CC -bundle -flat_namespace -undefined error \
              -o .libs/ \
              catalog.o connect.o cursor.o dll.o error.o execute.o \
              handle.o info.o misc.o myodbc3.o options.o prepare.o \
              results.o transact.o utility.o \
              -L/usr/local/mysql/lib/mysql/ \
              -L/usr/local/iodbc/lib/ \
              -lz -lc -lmysqlclient -liodbcinst

    Make sure to change -liodbcinst to -lodbcinst if you are using unixODBC instead of iODBC, and configure the library paths accordingly.

    This builds and places the file in the .libs directory. Copy this file to the Connector/ODBC library installation directory (/usr/local/lib (or the lib directory under the installation directory that you supplied with the --prefix).

    shell> cd .libs
    shell> cp /usr/local/lib
    shell> cd /usr/local/lib
    shell> ln -s

    To build the thread-safe driver library:

    shell> CC=/usr/bin/gcc \
              $CC -bundle -flat_namespace -undefined error
              -o .libs/
              catalog.o connect.o cursor.o dll.o error.o execute.o
              handle.o info.o misc.o myodbc3.o options.o prepare.o
              results.o transact.o utility.o
              -lz -lc -lmysqlclient_r -liodbcinst Installing Driver Libraries

    To install the driver libraries, execute the following command:

    shell> make install

    That command installs one of the following sets of libraries:

    For Connector/ODBC 3.51:


    •, where 3.51.01 is the version of the driver

    • libmyodbc3.a

    For thread-safe Connector/ODBC 3.51:



    • libmyodbc3_r.a

    For MyODBC 2.5.0:


    •, where 2.50.39 is the version of the driver

    • libmyodbc.a

    For more information on build process, refer to the INSTALL file that comes with the source distribution. Note that if you are trying to use the make from Sun, you may end up with errors. On the other hand, GNU gmake should work fine on all platforms. Testing Connector/ODBC on Unix

    To run the basic samples provided in the distribution with the libraries that you built, use the following command:

    shell> make test

    Before running the tests, create the DSN 'myodbc3' in odbc.ini and set the environment variable ODBCINI to the correct odbc.ini file; and MySQL server is running. You can find a sample odbc.ini with the driver distribution.

    You can even modify the samples/run-samples script to pass the desired DSN, UID, and PASSWORD values as the command-line arguments to each sample. Building Connector/ODBC from Source on Mac OS X

    To build the driver on Mac OS X (Darwin), make use of the following configure example:

    shell> ./configure --prefix=/usr/local

    The command assumes that the unixODBC and MySQL are installed in the default locations. If not, configure accordingly.

    On Mac OS X, --enable-shared builds .dylib files by default. You can build .so files like this:

    shell> make
    shell> cd driver
    shell> CC=/usr/bin/gcc \
              $CC -bundle -flat_namespace -undefined error
              -o .libs/ *.o
              -liodbcinst -lmysqlclient -lz -lc

    To build the thread-safe driver library:

    shell> CC=/usr/bin/gcc \
              $CC -bundle -flat_namespace -undefined error
              -o .libs/ *.o
              -liodbcinst -lmysqlclienti_r -lz -lc -lpthread

    Make sure to change the -liodbcinst to -lodbcinst in case of using unixODBC instead of iODBC and configure the libraries path accordingly.

    In Apple's version of GCC, both cc and gcc are actually symbolic links to gcc3.

    Copy this library to the $prefix/lib directory and symlink to

    You can cross-check the output shared-library properties using this command:

    shell> otool -LD .libs/ Building Connector/ODBC from Source on HP-UX

    To build the driver on HP-UX 10.x or 11.x, make use of the following configure example:

    If using cc:

    shell> CC="cc" \
              CFLAGS="+z" \
              LDFLAGS="-Wl,+b:-Wl,+s" \
              ./configure --prefix=/usr/local

    If using gcc:

    shell> CC="gcc" \
              LDFLAGS="-Wl,+b:-Wl,+s" \
              ./configure --prefix=/usr/local

    Once the driver is built, cross-check its attributes using chatr .libs/ to determine whether you need to have set the MySQL client library path using the SHLIB_PATH environment variable. For static versions, ignore all shared-library options and run configure with the --disable-shared option. Building Connector/ODBC from Source on AIX

    To build the driver on AIX, make use of the following configure example:

    shell> ./configure --prefix=/usr/local

    NOTE: For more information about how to build and set up the static and shared libraries across the different platforms refer to ' Using static and shared libraries across platforms'. Installing Connector/ODBC from the Development Source Tree

    Caution: You should read this section only if you are interested in helping us test our new code. If you just want to get MySQL Connector/ODBC up and running on your system, you should use a standard release distribution.

    To be able to access the Connector/ODBC source tree, you must have Subversion installed. Subversion is freely available from

    To build from the source trees, you need the following tools:

    • autoconf 2.52 (or newer)

    • automake 1.4 (or newer)

    • libtool 1.4 (or newer)

    • m4

    The most recent development source tree is available from our public Subversion trees at

    To checkout out the Connector/ODBC sources, change to the directory where you want the copy of the Connector/ODBC tree to be stored, then use the following command:

    shell> svn co

    You should now have a copy of the entire Connector/ODBC source tree in the directory connector-odbc3. To build from this source tree on Unix or Linux follow these steps:

    shell> cd connector-odbc3
    shell> aclocal
    shell> autoheader
    shell> autoconf
    shell> automake;
    shell> ./configure  # Add your favorite options here
    shell> make

    For more information on how to build, refer to the INSTALL file located in the same directory. For more information on options to configure, see Section, “Typical configure Options”

    When the build is done, run make install to install the Connector/ODBC 3.51 driver on your system.

    If you have gotten to the make stage and the distribution does not compile, please report it to .

    On Windows, make use of Windows Makefiles WIN-Makefile and WIN-Makefile_debug in building the driver. For more information, see Section, “Installing Connector/ODBC from a Source Distribution on Windows”.

    After the initial checkout operation to get the source tree, you should run svn update periodically update your source according to the latest version.

    23.1.3. Connector/ODBC Configuration

    Before you connect to a MySQL database using the Connector/ODBC driver you must configure an ODBC Data Source Name. The DSN associates the various configuration parameters required to communicate with a database to a specific name. You use the DSN in an application to communicate with the database, rather than specifying individual parameters within the application itself. DSN information can be user specific, system specific, or provided in a special file. ODBC data source names are configured in different ways, depending on your platform and ODBC driver. Data Source Names

    A Data Source Name associates the configuration parameters for communicating with a specific database. Generally a DSN consists of the following parameters:

    • Name
    • Hostname
    • Database Name
    • Login
    • Password

    In addition, different ODBC drivers, including Connector/ODBC, may accept additional driver-specific options and parameters.

    There are three types of DSN:

    • A System DSN is a global DSN definition that is available to any user and application on a particular system. A System DSN can normally only be configured by a systems administrator, or by a user who has specific permissions that let them create System DSNs.

    • A User DSN is specific to an individual user, and can be used to store database connectivity information that the user regularly uses.

    • A File DSN uses a simple file to define the DSN configuration. File DSNs can be shared between users and machines and are therefore more practical when installing or deploying DSN information as part of an application across many machines.

    DSN information is stored in different locations depending on your platform and environment. Configuring a Connector/ODBC DSN on Windows

    The ODBC Data Source Administrator within Windows enables you to create DSNs, check driver installation and configure ODBC systems such as tracing (used for debugging) and connection pooling.

    Different editions and versions of Windows store the ODBC Data Source Administrator in different locations depending on the version of Windows that you are using.

    To open the ODBC Data Source Administrator in Windows Server 2003:

    1. On the Start menu, choose Administrative Tools, and then click Data Sources (ODBC).

    To open the ODBC Data Source Administrator in Windows 2000 Server or Windows 2000 Professional:

    1. On the Start menu, choose Settings, and then click Control Panel.

    2. In Control Panel, click Administrative Tools.

    3. In Administrative Tools, click Data Sources (ODBC).

    To open the ODBC Data Source Administrator on Windows XP:

    1. On the Start menu, click Control Panel.

    2. In the Control Panel when in Category View click Performance and Maintenance and then click Administrative Tools.. If you are viewing the Control Panel in Classic View, click Administrative Tools.

    3. In Administrative Tools, click Data Sources (ODBC).

    Irrespective of your Windows version, you should be presented the ODBC Data Source Administrator window:

    Within Windows XP, you can add the Administrative Tools folder to your Start menu to make it easier to locate the ODBC Data Source Administrator. To do this:

    1. Right click on the Start menu.

    2. Select Properties.

    3. Click Customize....

    4. Select the Advanced tab.

    5. Within Start menu items, within the System Administrative Tools section, select Display on the All Programs menu.

    Within both Windows Server 2003 and Windows XP you may want to permanently add the ODBC Data Source Administrator to your Start menu. To do this, locate the Data Sources (ODBC) icon using the methods shown, then right-click on the icon and then choose Pin to Start Menu. Adding a Connector/ODBC DSN on Windows

    To add and configure a new Connector/ODBC data source on Windows, use the ODBC Data Source Administrator:

    1. Open the ODBC Data Source Administrator.

    2. To create a System DSN (which will be available to all users) , select the System DSN tab. To create a User DSN, which will be unique only to the current user, click the Add... button.

    3. You will need to select the ODBC driver for this DSN.

      Select MySQL ODBC 3.51 Driver, then click Finish.

    4. You now need to configure the specific fields for the DSN you are creating through the Add Data Source Name dialog.

      In the Data Source Name box, enter the name of the data source you want to access. It can be any valid name that you choose.

    5. In the Description box, enter some text to help identify the connection.

    6. In the Server field, enter the name of the MySQL server host that you want to access. By default, it is localhost.

    7. In the User field, enter the user name to use for this connection.

    8. In the Password field, enter the corresponding password for this connection.

    9. The Database popup should automatically populate with the list of databases that the user has permissions to access.

    10. Click OK to save the DSN.

    A completed DSN configuration may look like this: Checking Connector/ODBC DSN Configuration on Windows

    You can verify the connection using the parameters you have entered by clicking the Test button. If the connection could be made successfully, you will be notified with a Success; connection was made! dialog.

    If the connection failed, you can obtain more information on the test and why it may have failed by clicking the Diagnostics... button to show additional error messages. Connector/ODBC DSN Configuration Options

    You can configure a number of options for a specific DSN by using either the Connect Options or Advanced tabs in the DSN configuration dialog.

    The Connection Options dialog can be seen below.

    The three options you can configure are:

    • Port sets the TCP/IP port number to use when communicating with MySQL. Communication with MySQL uses port 3306 by default. If your server is configured to use a different TCP/IP port, you must specify that port number here.

    • Socket sets the name or location of a specific socket or Windows pipe to use when communicating with MySQL.

    • Initial Statement defines an SQL statement that will be executed when the connection to MySQL is opened. You can use this to set MySQL options for your connection, such as setting the default character set or database to use during your connection.

    The Advanced tab enables you to configure Connector/ODBC connection parameters. Refer to Section, “Connector/ODBC Connection Parameters”, for information about the meaning of these options. Errors and Debugging

    This section answers Connector/ODBC connection-related questions.

    • While configuring a Connector/ODBC DSN, a Could Not Load Translator or Setup Library error occurs

      For more information, refer to MS KnowledgeBase Article(Q260558). Also, make sure you have the latest valid ctl3d32.dll in your system directory.

    • On Windows, the default myodbc3.dll is compiled for optimal performance. If you want to debug Connector/ODBC 3.51 (for example, to enable tracing), you should instead use myodbc3d.dll. To install this file, copy myodbc3d.dll over the installed myodbc3.dll file. Make sure to revert back to the release version of the driver DLL once you are done with the debugging because the debug version may cause performance issues. Note that the myodbc3d.dll isn't included in Connector/ODBC 3.51.07 through 3.51.11. If you are using one of these versions, you should copy that DLL from a previous version (for example, 3.51.06).

      For MyODBC 2.50, myodbc.dll and myodbcd.dll are used instead. Configuring a Connector/ODBC DSN on Mac OS X

    To configure a DSN on Mac OS X you should use the ODBC Administrator. If you have Mac OS X 10.2 or earlier, refer to Section, “Configuring a Connector/ODBC DSN on Unix”. Select whether you want to create a User DSN or a System DSN. If you want to add a System DSN, you may need to authenticate with the system. You must click the padlock and enter a user and password with administrator privileges.

    1. Open the ODBC Administrator from the Utilities folder in the Applications folder.

    2. On the User DSN or System DSN panel, click Add.

    3. Select the Connector/ODBC driver and click OK.

    4. You will be presented with the Data Source Name dialog. Enter The Data Source Name and an optional Description for the DSN.

    5. Click Add to add a new keyword/value pair to the panel. You should configure at least four pairs to specify the server, username, password and database connection parameters. See Section, “Connector/ODBC Connection Parameters”.

    6. Click OK to add the DSN to the list of configured data source names.

    A completed DSN configuration may look like this:

    You can configure additional ODBC options to your DSN by adding further keyword/value pairs and setting the corresponding values. See Section, “Connector/ODBC Connection Parameters”. Configuring a Connector/ODBC DSN on Unix

    On Unix, you configure DSN entries directly in the odbc.ini file. Here is a typical odbc.ini file that configures myodbc and myodbc3 as the DSN names for MyODBC 2.50 and Connector/ODBC 3.51, respectively:

    ;  odbc.ini configuration for Connector/ODBC and Connector/ODBC 3.51 drivers
    [ODBC Data Sources]
    myodbc      = MyODBC 2.50 Driver DSN
    myodbc3     = MyODBC 3.51 Driver DSN
    Driver       = /usr/local/lib/
    Description  = MyODBC 2.50 Driver DSN
    SERVER       = localhost
    PORT         =
    USER         = root
    Password     =
    Database     = test
    OPTION       = 3
    SOCKET       =
    Driver       = /usr/local/lib/
    Description  = Connector/ODBC 3.51 Driver DSN
    SERVER       = localhost
    PORT         =
    USER         = root
    Password     =
    Database     = test
    OPTION       = 3
    SOCKET       =
    Driver       = /usr/local/lib/
    Description  = Connector/ODBC 3.51 Driver DSN
    SERVER       = localhost
    PORT         =
    USER         = root
    Password     =
    Database     = test
    OPTION       = 3
    SOCKET       =

    Refer to the Section, “Connector/ODBC Connection Parameters”, for the list of connection parameters that can be supplied.

    Note: If you are using unixODBC, you can use the following tools to set up the DSN:

    In some cases when using unixODBC, you might get this error:

    Data source name not found and no default driver specified

    If this happens, make sure the ODBCINI and ODBCSYSINI environment variables are pointing to the right odbc.ini file. For example, if your odbc.ini file is located in /usr/local/etc, set the environment variables like this:

    export ODBCINI=/usr/local/etc/odbc.ini
    export ODBCSYSINI=/usr/local/etc Connector/ODBC Connection Parameters

    You can specify the parameters in the following tables for Connector/ODBC when configuring a DSN. Users on Windows can use the Options and Advanced panels when configuring a DSN to set these parameters; see the table for information on which options relate to which fields and checkboxes. On Unix and Mac OS X, use the parameter name and value as the keyword/value pair in the DSN configuration. Alternatively, you can set these parameters within the InConnectionString argument in the SQLDriverConnect() call.

    ParameterDefault ValueComment
    userODBC (on Windows)The username used to connect to MySQL.
    serverlocalhostThe hostname of the MySQL server.
    database The default database.
    option0Options that specify how Connector/ODBC should work. See below.
    port3306The TCP/IP port to use if server is not localhost.
    stmt A statement to execute when connecting to MySQL.
    password The password for the user account on server.
    socket The Unix socket file or Windows named pipe to connect to if server is localhost.

    The option argument is used to tell Connector/ODBC that the client isn't 100% ODBC compliant. On Windows, you normally select options by toggling the checkboxes in the connection screen, but you can also select them in the option argument. The following options are listed in the order in which they appear in the Connector/ODBC connect screen:

    ValueWindows CheckboxDescription
    1Don't Optimized Column WidthThe client can't handle that Connector/ODBC returns the real width of a column.
    2Return Matching RowsThe client can't handle that MySQL returns the true value of affected rows. If this flag is set, MySQL returns “found rows” instead. You must have MySQL 3.21.14 or newer to get this to work.
    4Trace Driver Calls To myodbc.logMake a debug log in C:\myodbc.log on Windows, or /tmp/myodbc.log on Unix variants.
    8Allow Big ResultsDon't set any packet limit for results and parameters.
    16Don't Prompt Upon ConnectDon't prompt for questions even if driver would like to prompt.
    32Enable Dynamic CursorEnable or disable the dynamic cursor support. (Not allowed in Connector/ODBC 2.50.)
    64Ignore # in Table NameIgnore use of database name in db_name.tbl_name.col_name.
    128User Manager CursorsForce use of ODBC manager cursors (experimental).
    256Don't Use Set LocaleDisable the use of extended fetch (experimental).
    512Pad Char To Full LengthPad CHAR columns to full column length.
    1024Return Table Names for SQLDescribeColSQLDescribeCol() returns fully qualified column names.
    2048Use Compressed ProtocolUse the compressed client/server protocol.
    4096Ignore Space After Function NamesTell server to ignore space after function name and before ‘(’ (needed by PowerBuilder). This makes all function names keywords.
    8192Force Use of Named PipesConnect with named pipes to a mysqld server running on NT.
    16384Change BIGINT Columns to IntChange BIGINT columns to INT columns (some applications can't handle BIGINT).
    32768No Catalog (exp)Return 'user' as Table_qualifier and Table_owner from SQLTables (experimental).
    65536Read Options From my.cnfRead parameters from the [client] and [odbc] groups from my.cnf.
    131072SafeAdd some extra safety checks (should not be needed but...).
    262144Disable transactionDisable transactions.
    524288Save queries to myodbc.sqlEnable query logging to c:\myodbc.sql(/tmp/myodbc.sql) file. (Enabled only in debug mode.)
    1048576Don't Cache Result (forward only cursors)Do not cache the results locally in the driver, instead read from server (mysql_use_result()). This works only for forward-only cursors. This option is very important in dealing with large tables when you don't want the driver to cache the entire result set.
    2097152Force Use Of Forward Only CursorsForce the use of Forward-only cursor type. In case of applications setting the default static/dynamic cursor type, and one wants the driver to use non-cache result sets, then this option ensures the forward-only cursor behavior.
    4194304Enable auto-reconnect.Enables auto-reconnection functionality. You should not use this option with transactions, since a auto reconnection during a incomplete transaction may cause corruption. Note that an auto-reconnected connection will not inherit the same settings and environment as the original. This option was enabled in Connector/ODBC 3.5.13.
    8388608Flag Auto Is NullWhen set, this option causes the connection to set the SQL_AUTO_IS_NULL option to 1. This disables the standard behavior, but may enable older applications to correctly identify AUTO_INCREMENT values. For more information. See IS NULL This option was enabled in Connector/ODBC 3.5.13.

    To select multiple options, add together their values. For example, setting option to 12 (4+8) gives you debugging without packet limits.

    The following table shows some recommended option values for various configurations:

    ConfigurationOption Value
    Microsoft Access, Visual Basic3
    Driver trace generation (Debug mode)4
    Microsoft Access (with improved DELETE queries)35
    Large tables with too many rows2049
    Sybase PowerBuilder135168
    Query log generation (Debug mode)524288
    Generate driver trace as well as query log (Debug mode)524292
    Large tables with no-cache results3145731 Connecting Without a Predefined DSN

    You can connect to the MySQL server using SQLDriverConnect, by specifying the DRIVER name field. Here are the connection strings for Connector/ODBC using DSN-Less connections:

    For MyODBC 2.50:

    ConnectionString = "DRIVER={MySQL};\

    For Connector/ODBC 3.51:

    ConnectionString = "DRIVER={MySQL ODBC 3.51 Driver};\

    If your programming language converts backslash followed by whitespace to a space, it is preferable to specify the connection string as a single long string, or to use a concatenation of multiple strings that does not add spaces in between. For example:

    ConnectionString = "DRIVER={MySQL ODBC 3.51 Driver};"

    Note.  Note that on Mac OS X you may need to specify the full path to the Connector/ODBC driver library.

    Refer to the Section, “Connector/ODBC Connection Parameters”, for the list of connection parameters that can be supplied. ODBC Connection Pooling

    Connection pooling enables the ODBC driver to re-use existing connections to a given database from a pool of connections, instead of opening a new connection each time the database is accessed. By enabling connection pooling you can improve the overall performance of your application by lowering the time taken to open a connection to a database in the connection pool.

    For more information about connection pooling:;EN-US;q169470. Getting an ODBC Trace File

    If you encounter difficulties or problems with Connector/ODBC, you should start by making a log file from the ODBC Manager and Connector/ODBC. This is called tracing, and is enabled through the ODBC Manager. The procedure for this differs for Windows, Mac OS X and Unix. Enabling ODBC Tracing on Windows

    To enable the trace option on Windows:

    1. The Tracing tab of the ODBC Data Source Administrator dialog box enables you to configure the way ODBC function calls are traced.

    2. When you activate tracing from the Tracing tab, the Driver Manager logs all ODBC function calls for all subsequently run applications.

    3. ODBC function calls from applications running before tracing is activated are not logged. ODBC function calls are recorded in a log file you specify.

    4. Tracing ceases only after you click Stop Tracing Now. Remember that while tracing is on, the log file continues to increase in size and that tracing affects the performance of all your ODBC applications. Enabling ODBC Tracing on Mac OS X

    To enable the trace option on Mac OS X 10.3 or later you should use the Tracing tab within ODBC Administrator .

    1. Open the ODBC Administrator.

    2. Select the Tracing tab.

    3. Select the Enable Tracing checkbox.

    4. Enter the location where you want to save the Tracing log. If you want to append information to an existing log file, click the Choose... button. Enabling ODBC Tracing on Unix

    To enable the trace option on Mac OS X 10.2 (or earlier) or Unix you must add the trace option to the ODBC configuration:

    1. On Unix, you need to explicitly set the Trace option in the ODBC.INI file.

      Set the tracing ON or OFF by using TraceFile and Trace parameters in odbc.ini as shown below:

      TraceFile  = /tmp/odbc.trace
      Trace      = 1

      TraceFile specifies the name and full path of the trace file and Trace is set to ON or OFF. You can also use 1 or YES for ON and 0 or NO for OFF. If you are using ODBCConfig from unixODBC, then follow the instructions for tracing unixODBC calls at HOWTO-ODBCConfig. Enabling a Connector/ODBC Log

    To generate a Connector/ODBC log, do the following:

    1. Within Windows, enable the Trace Connector/ODBC option flag in the Connector/ODBC connect/configure screen. The log is written to file C:\myodbc.log. If the trace option is not remembered when you are going back to the above screen, it means that you are not using the myodbcd.dll driver, see Section, “Errors and Debugging”.

      On Mac OS X, Unix, or if you are using DSN-Less connection, then you need to supply OPTION=4 in the connection string or set the corresponding keyword/value pair in the DSN.

    2. Start your application and try to get it to fail. Then check the Connector/ODBC trace file to find out what could be wrong.

    If you need help determining what is wrong, see Section, “Connector/ODBC Community Support”.

    23.1.4. Connector/ODBC Examples

    Once you have configured a DSN to provide access to a database, how you access and use that connection is dependent on the application or programming language. As ODBC is a standardized interface, any application or language that supports ODBC can use the DSN and connect to the configured database. Basic Connector/ODBC Application Steps

    Interacting with a MySQL server from an applications using the Connector/ODBC typically involves the following operations:

    • Configure the Connector/ODBC DSN

    • Connect to MySQL server

    • Initialization operations

    • Execute SQL statements

    • Retrieve results

    • Perform Transactions

    • Disconnect from the server

    Most applications use some variation of these steps. The basic application steps are shown in the following diagram: Step-by-step Guide to Connecting to a MySQL Database through Connector/ODBC

    A typical installation situation where you would install Connector/ODBC is when you want to access a database on a Linux or Unix host from a Windows machine.

    As an example of the process required to set up access between two machines, the steps below take you through the basic steps. These instructions assume that you want to connect to system ALPHA from system BETA with a username and password of myuser and mypassword.

    On system ALPHA (the MySQL server) follow these steps:

    1. Start the MySQL server.

    2. Use GRANT to set up an account with a username of myuser that can connect from system BETA using a password of myuser to the database test:

      GRANT ALL ON test.* to 'myuser'@'BETA' IDENTIFIED BY 'mypassword';

      For more information about MySQL privileges, refer to Section 5.8, “MySQL User Account Management”.

    On system BETA (the Connector/ODBC client), follow these steps:

    1. Configure a Connector/ODBC DSN using parameters that match the server, database and authentication information that you have just configured on system ALPHA.

      DSNremote_testA name to identify the connection.
      SERVERALPHAThe address of the remote server.
      DATABASEtestThe name of the default database.
      USERmyuserThe username configured for access to this database.
      PASSWORDmypasswordThe password for myuser.
    2. Using an ODBC-capable application, such as Microsoft Office, connect to the MySQL server using the DSN you have just created. If the connection fails, use tracing to examine the connection process. See Section, “Getting an ODBC Trace File”, for more information. Connector/ODBC and Third-Party ODBC Tools

    Once you have configured your Connector/ODBC DSN, you can access your MySQL database through any application that supports the ODBC interface, including programming languages and third-party applications. This section contains guides and help on using Connector/ODBC with various ODBC-compatible tools and applications, including Microsoft Word, Microsoft Excel and Adobe/Macromedia ColdFusion.

    Connector/ODBC has been tested with the following applications:

    AdobeColdFusionFormerly Macromedia ColdFusion
    BorlandC++ Builder 
     Builder 4 
    Business ObjectsCrystal Reports 
    ClarisFilemaker Pro 
    Computer AssociatesVisual ObjectsAlso known as CAVO
     AllFusion ERwin Data Modeler 
    GuptaTeam DeveloperPreviously known as Centura Team Developer; Gupta SQL/Windows
    GensymG2-ODBC Bridge 
    LotusNotesVersions 4.5 and 4.6
     Visio Enterprise 
     Visual C++ 
     Visual Basic 
     ODBC.NETUsing C#, Visual Basic, C++
     Visual Interdev 
    Pervasive SoftwareDataJunction 
    Sambar TechnologiesSambar Server 
    SQLExpressSQLExpress for Xbase++ 
    theKompany.comData Architect 

    If you know of any other applications that work with Connector/ODBC, please send mail to about them. Using Connector/ODBC with Microsoft Access

    You can use MySQL database with Microsoft Access using Connector/ODBC. The MySQL database can be used as an import source, an export source, or as a linked table for direct use within an Access application, so you can use Access as the front-end interface to a MySQL database. Exporting Access Data to MySQL

    To export a table of data from an Access database to MySQL, follow these instructions:

    1. When you open an Access database or an Access project, a Database window appears. It displays shortcuts for creating new database objects and opening existing objects.

    2. Click the name of the table or query you want to export, and then in the File menu, select Export.

    3. In the Export Object Type Object name To dialog box, in the Save As Type box, select ODBC Databases () as shown here:

    4. In the Export dialog box, enter a name for the file (or use the suggested name), and then select OK.

    5. The Select Data Source dialog box is displayed; it lists the defined data sources for any ODBC drivers installed on your computer. Click either the File Data Source or Machine Data Source tab, and then double-click the Connector/ODBC or Connector/ODBC 3.51 data source that you want to export to. To define a new data source for Connector/ODBC, please Section, “Configuring a Connector/ODBC DSN on Windows”.

    Microsoft Access connects to the MySQL Server through this data source and exports new tables and or data. Importing MySQL Data to Access

    To import a table or tables from MySQL to Access, follow these instructions:

    1. Open a database, or switch to the Database window for the open database.

    2. To import tables, on the File menu, point to Get External Data, and then click Import.

    3. In the Import dialog box, in the Files Of Type box, select ODBC Databases (). The Select Data Source dialog box lists the defined data sources The Select Data Source dialog box is displayed; it lists the defined data source names.

    4. If the ODBC data source that you selected requires you to log on, enter your login ID and password (additional information might also be required), and then click OK.

    5. Microsoft Access connects to the MySQL server through ODBC data source and displays the list of tables that you can import.

    6. Click each table that you want to import, and then click OK. Using Microsoft Access as a Front-end to MySQL

    You can use Microsoft Access as a front end to a MySQL database by linking tables within your Microsoft Access database to tables that exist within your MySQL database. When a query is requested on a table within Access, ODBC is used to execute the queries on the MySQL database instead.

    To create a linked table:

    1. Open the Access database that you want to link to MySQL.

    2. From the File, choose Get External Data->Link Tables.

    3. From the browser, choose ODBC Databases () from the Files of type popup.

    4. In the Select Data Source window, choose an existing DSN, either from a File Data Source or Machine Data Source.You can also create a new DSN using the New... button. For more information on creating a DSN see Section, “Configuring a Connector/ODBC DSN on Windows”