ODBC Driver for MySQL

Connection Options

MySQL Connection Options

The following table describes the options that you can include in the connection string for MySQL:

Option Description


Serves to supply the server name for login.


Used to specify the port number for the connection. 3307 by default.


Used to supply a user name for login.


Used to supply a password for login.


Used to set the name of the database


Used to work without using MySQL client library (libmysql.dll).


Used to specify the embedded server that will be used to connect.


Used to set the character set that ODBC driver for MySQL uses to read and write character data.


Informs server that all data between client and server sides will be passed in Utf8 coding. Setting this option converts all fields of the String type into WideString that allows to work correctly with symbols of almost all languages simultaneously. On the other hand, it causes a delay in working. If the Use Unicode property is enabled, the Charset property will be ignored. The default value is False.


Used to specify the time in seconds before an attempt to make a connection is considered unsuccessful.


Used to specify the version of the Internet Protocol. Ipv4 and Ipv6 are available. The IPBoth option value allows to check for available protocol versions and use the first available automatically.


Used to apply compression on transferring data. Setting this property to True is quite effective on transferring big volumes of data through slow connection. Pay attention that each row is compressed separately. Be careful when setting this option as in some cases it may decrease fetch speed instead of increasing. The default value is False.


Permit interactive_timeout seconds (instead of wait_timeout seconds) of inactivity before closing the connection. The client's session wait_timeout variable is set to the value of the session interactive_timeout variable. The default value is false.

Advanced Settings

Option Description

Empty strings as NULL

To retrieve metadata, not all parameters according to MSDN can accept a null value. If NULL, the driver should return an error. But some 3rd-party tools pass NULL to the parameters. These options should be enabled for compatibility with such tools.

Allow NULL strings


Enables using local regional settings when converting numbers to string.


Enables using local regional settings when converting dates and times to string.

Example Connection String

Login Prompt=False;User ID=root;Password=root;Data Source=localhost;Database=test

SSL Connection Options

Option Description


Enables or disables SSL for connection.


Holds the pathname to the certificate authority file.

SSL Cert

Holds the pathname to the certificate file.

SSL CipherList

Holds the list of allowed ciphers to use for SSL encryption.


Holds the pathname to the key file.

Example connection string using SSL

Login Prompt=False;User ID=root;Password=root;Server=db;Port=3307;Database=test;Use SSL=true;SSL CACert=c:\cacert.pem;SSL Cert=c:\client-cert.pem;SSL Key=c:\client-key.pem;SSL CipherList=ALL

SSH Connection Options

Option Description


Enables or disables SSH tunneling.

SSH Host name

Holds the host name or IP address of the SSH server to connect to.

SSH Port

Used to specify the port number for SSH connection.

SSH User Name

Sets the SSH user name for authentication.

SSH Password

Sets the SSH user password for authentication.

SSH Client Key

Used to specify the path to the file containing the SSH Private Key.

If the authentication by key is used, the user must have his pair of keys. The public key should be transferred to the server, while the private key will be used by the client to sign data, that will be used by server to authenticate the user. The server verifies the specified user name and Private Key - and if the Server Key corresponds to this user, connection may be established.

SSH Server Key

Used to specify the path to the file that contains SSH Public Key.

Example connection string using SSH

Login Prompt=False;User ID=root;Password=root;Server=db;Port=3307;Database=test;Use SSH=true;SSH Hostname=localhost;SSH Port=22;SSH Username=SSHUser;SSH Password=SSHPass;SSH Client Key='C:\User\...\PrivateKey.pem';SSH Server Key='C:\User\...\PublicKey.pem';

HTTP Connection Options

Option Description

Use Http

Enables or disables HTTP tunneling.

Http Url

Holds the url of the tunneling PHP script.

Http Username

Holds the user name for HTTP authorization.

Http Password

Holds the password for HTTP authorization.

Proxy Host Name

If you are using Proxy for connection to your network, specify the Proxy server address in this option. To learn your Proxy server address, open Control Panel->Internet Options->Connections->LAN settings.

Proxy Port

Used to specify the port number for TCP/IP connection with proxy server.

Proxy Username

Holds the proxy server account name.

Proxy Password

Holds the password for the proxy server account.

Example connection string using HTTP Tunnel

Login Prompt=False;User ID=root;Password=root;Data Source=localhost;Database=test;Use Http=true;Url=http://server/tunnel.php;Http Username=HttpUser;Http Password=HttpPassword;

Example connection string using Proxy and HTTP Tunnel

Login Prompt=False;User ID=root;Password=root;Data Source=;Port=3307;Database=test;Use Http=true;Url=http://server/tunnel.php;Proxy Hostname=;Proxy Port=808;Proxy User=ProxyUser;Proxy Password=ProxyPassword;
© 2015-2017 Devart. All Rights Reserved. Request Support ODBC Forum Provide Feedback