Connection Properties
The connection properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection settings for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| AuthScheme | Specifies the authentication scheme used to connect to the data source. This determines how the user or application credentials are validated. Choose an option supported by your MySQL server database. |
| Server | Specifies the host name or IP address of the MySQL server to connect to. This property supports both single-server and clustered environments through comma-separated values. |
| Port | Specifies the port number used to connect to the MySQL server. This property supports both single-node and clustered environments. For clusters, you may specify a comma-separated list of ports that correspond to each server in the Server property. |
| User | Specifies the authenticating user's user ID. |
| Password | Specifies the authenticating user's password. |
| Database | Specifies the name of the MySQL database to connect to by default. This determines the active schema used for queries unless explicitly overridden. |
| Domain | Specifies the Windows domain name to use when the AuthScheme is NTLM, which enables Windows Integrated Authentication using the NTLM protocol. This value is required if the user account belongs to a domain other than the local machine or default network domain. |
| NTLMVersion | Specifies the version of the NTLM protocol to use when authenticating with Windows credentials. This setting is only applicable when AuthScheme=NTLM. |
| IntegratedUser | Specifies the Windows user account to be used when authenticating with NTLM. This value is only applicable when AuthScheme=NTLM and is used to explicitly identify the integrated user for domain-based authentication. |
| UseSSL | This property determines whether Secure Sockets Layer (SSL) is enabled for communication. By default, SSL is set to 'false', meaning that communications are not encrypted unless explicitly enabled. |
| Property | Description |
| AWSAccessKey | Specifies your AWS account access key. This value is accessible from your AWS security credentials page. |
| AWSSecretKey | Your AWS account secret key. This value is accessible from your AWS security credentials page. |
| AWSRoleARN | The Amazon Resource Name of the role to use when authenticating. |
| Property | Description |
| AzureTenant | Identifies the MySQL tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID. |
| Property | Description |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| Scope | Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created. |
| Property | Description |
| SSLClientCert | Specifies the TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). This property works in conjunction with other SSL-related properties to establish a secure connection. |
| SSLClientCertType | Specifies the type of key store containing the TLS/SSL client certificate for SSL Client Authentication. Choose from a variety of key store formats depending on your platform and certificate source. |
| SSLClientCertPassword | Specifes the password required to access the TLS/SSL client certificate store. Use this property if the selected certificate store type requires a password for access. |
| SSLClientCertSubject | Specifes the subject of the TLS/SSL client certificate to locate it in the certificate store. Use a comma-separated list of distinguished name fields, such as CN=www.server.com, C=US. The wildcard * selects the first certificate in the store. |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| SSHAuthMode | The authentication method used when establishing an SSH Tunnel to the service. |
| SSHClientCert | A certificate to be used for authenticating the SSHUser. |
| SSHClientCertPassword | The password of the SSHClientCert key if it has one. |
| SSHClientCertSubject | The subject of the SSH client certificate. |
| SSHClientCertType | The type of SSHClientCert private key. |
| 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. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| Logfile | Specifes the file path to the log file where the provider records its activities, such as authentication, query execution, and connection details. |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| MaxLogFileSize | Specifies the maximum size of a single log file in bytes. For example, '10 MB'. When the file reaches the limit, the provider creates a new log file with the date and time appended to the name. |
| MaxLogFileCount | Specifies the maximum number of log files the provider retains. When the limit is reached, the oldest log file is deleted to make space for a new one. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Property | Description |
| AutoCache | Specifies whether the content of tables targeted by SELECT queries is automatically cached to the specified cache database. |
| CacheProvider | The namespace of an ADO.NET provider. The specified provider is used as the target database for all caching operations. |
| CacheConnection | Specifies the connection string for the specified cache database. |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | Notes the tolerance, in seconds, for stale data in the specified cache database. Requires AutoCache to be set to True. |
| Offline | Gets the data from the specified cache database instead of live MySQL data. |
| CacheMetadata | Determines whether the provider caches table metadata to a file-based cache database. |
| Property | Description |
| AllowUserVariables | Specifies whether user-defined variables (prefixed with @) are allowed in SQL queries. When enabled, the driver treats these as in-query user variables instead of parameter placeholders, allowing advanced SQL scripting patterns, such as variable assignment and conditional logic. |
| Characterset | Specifies the default client character set used by the provider for encoding queries it sends to the server. |
| DateTimeTimeZone | Specifies the timezone to apply to DATETIME types. |
| EnsureKeepAlive | Setting this property to 'true' means that provider pings the server before performing a request, so the driver knows if the connection has been dropped since the last request. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Other | Specifies additional hidden properties for specific use cases., to be used only when our Support team advises it, to address specific issues. See Remarks for details. |
| QueryPassthrough | This option passes the query to the MySQL server as is. |
| Readonly | Toggles read-only access to MySQL from the provider. |
| ServerTimeZone | Specifies the timezone identifier for the MySQL server, based on the current edition and platform. This setting controls how the driver interprets and converts datetime values between the server and client. |
| Timeout | This setting defines how long (in seconds) an operation is allowed to run before the system automatically considers it as having timed out. If the operation does not finish within the specified time, a timeout error is thrown. The default value is set to 30 seconds. |
| TinyInt1Type | Defines the presentation type used to display small integer values. |
| ZeroDatesToNull | This property determines whether Date and DateTime values consisting entirely of zeros (for example, '0000-00-00' or '0000-00-00 00:00:00') are returned as NULL values. By default, this property is set to 'true', meaning any invalid date or datetime values represented as all zeros is returned as NULL instead of their original value. |