36. MySQL
36.1. MySQL Version Support
The driver enables connectivity to MySQL Server through 5.0 to 8.0.
 
36.2. Connection Options
36.2.1. Authentication
Property
Description
AuthScheme
The scheme used for authentication. Accepted entries are Password, AzureAD, AzurePassword, AzureMSI.
Server
The host name or IP address of the server. Supports cluster servers, for example '192.168.0.1,192.168.0.2'.
Port
The port of the MySQL server. Supports cluster servers, for example: '3306, 3307', the number of the port should match with Servers.
User
The MySQL user account used to authenticate.
Password
The password used to authenticate the user.
Database
The name of the MySQL database.
Domain
The name of the domain for a Windows (NTLM) security login.
NTLMVersion
The NTLM version.
IntegratedUser
The user that is authenticating to the Windows.
UseSSL
This field sets whether SSL is enabled.
36.2.2. Azure Authentication
Property
Description
AzureTenant
The Microsoft Online tenant being used to access data. If not specified, your default tentant will be used.
36.2.3. OAuth
Property
Description
InitiateOAuth
Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
OAuthClientId
The client ID assigned when you register your application with an OAuth authorization server.
OAuthClientSecret
The client secret assigned when you register your application with an OAuth authorization server.
OAuthAccessToken
The access token for connecting using OAuth.
OAuthSettingsLocation
The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://.
OAuthVerifier
The verifier code returned from the OAuth authorization URL.
OAuthExpiresIn
The lifetime in seconds of the OAuth AccessToken.
OAuthTokenTimestamp
The Unix epoch timestamp in milliseconds when the current Access Token was created.
36.2.4. SSL
Property
Description
SSLClientCert
The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
SSLClientCertType
The type of key store containing the TLS/SSL client certificate.
SSLClientCertPassword
The password for the TLS/SSL client certificate.
SSLClientCertSubject
The subject of the TLS/SSL client certificate.
SSLServerCert
The certificate to be accepted from the server when connecting using TLS/SSL.
36.2.5. SSH
Property
Description
SSHAuthMode
The authentication method to be used to log on to an SFTP server.
SSHClientCert
A certificate to be used for authenticating the user.
SSHClientCertPassword
The password of the SSHClientCert certificate if it has one.
SSHClientCertSubject
The subject of the SSH client certificate.
SSHClientCertType
The type of SSHClientCert certificate.
SSHServer
The SSH server.
SSHPort
The SSH port.
SSHUser
The SSH user.
SSHPassword
The SSH password.
SSHServerFingerprint
The SSH server fingerprint.
UseSSH
Whether to tunnel the MySQL connection over SSH. Use SSH.
36.2.6. Firewall
Property
Description
FirewallType
The protocol used by a proxy-based firewall.
FirewallServer
The name or IP address of a proxy-based firewall.
FirewallPort
The TCP port for a proxy-based firewall.
FirewallUser
The user name to use to authenticate with a proxy-based firewall.
FirewallPassword
A password used to authenticate to a proxy-based firewall.
36.2.7. Proxy
Property
Description
ProxyAutoDetect
This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyServer
The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort
The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme
The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser
A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword
A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType
The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions
A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
36.2.8. Logging
Property
Description
Logfile
A filepath which designates the name and location of the log file.
Verbosity
The verbosity level that determines the amount of detail included in the log file.
LogModules
Core modules to be included in the log file.
MaxLogFileSize
A string specifying the maximum size in bytes for a log file (for example, 10 MB).
MaxLogFileCount
A string specifying the maximum file count of log files.
36.2.9. Schema
Property
Description
Location
A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
36.2.10. Miscellaneous
Property
Description
AllowUserVariables
When set to True, user variables (prefixed by an @) can be used in SQL queries.
BatchSize
The maximum size of each batch operation to submit.
Characterset
The default client character set used by the provider. For example, 'utf8'.
ConnectionLifeTime
The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
ConnectOnOpen
This property species whether to connect to the MySQL when the connection is opened.
MaxRows
Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other
These hidden properties are used only in specific use cases.
PoolIdleTimeout
The allowed idle time for a connection before it is closed.
PoolMaxSize
The maximum connections in the pool.
PoolMinSize
The minimum number of connections in the pool.
PoolWaitTime
The max seconds to wait for an available connection.
QueryPassthrough
This option passes the query to the MySQL server as is.
Readonly
You can use this property to enforce read-only access to MySQL from the provider.
RTK
The runtime key used for licensing.
ServerTimeZone
Specify a specific server time zone id of current platform(.Net or Java) by user.
Timeout
The value in seconds until the connection timeout error is thrown.
UseConnectionPooling
This property enables connection pooling.
ZeroDatesToNull
Whether or not to return Date and DateTime values consisting of all zeros as NULL.