There are also several unique options that are supported only by MySqlConnector, a replacement for
MySql.Data that fixes bugs,
adds new features, and improves database access performance. Install it now.
These are the basic options that need to be defined to connect to a MySQL database.
|Host, Server, Data Source, DataSource, Address, Addr, Network Address||localhost||The host name or network address of the MySQL Server to which to connect. Multiple hosts can be specified in a comma-delimited list.|
On Unix-like systems, this can be a fully qualified path to a MySQL socket file, which will cause a Unix socket to be used instead of a TCP/IP socket. Only a single socket name can be specified.
|Port||3306||The TCP port on which MySQL Server is listening for connections.|
|User Id, UserID, Username, Uid, User name, User||The MySQL user ID.|
|Password, pwd||The password for the MySQL user.|
|Database, Initial Catalog||(Optional) The case-sensitive name of the initial database to use. This may be required if the MySQL user account only has access rights to particular databases on the server.|
|Protocol, ConnectionProtocol, Connection Protocol||Socket||How to connect to the MySQL Server. This option has the following values:|
- Socket (default): Use TCP/IP sockets.
- Unix: Use a Unix socket.
- Pipe: Use a Windows named pipe.
|Pipe, PipeName, Pipe Name||MYSQL||The name of the Windows named pipe to use to connect to the server. You must also set |
ConnectionProtocol=pipe to used named pipes.
These are the options that need to be used in order to configure a connection to use SSL/TLS.
|SSL Mode, SslMode||Preferred||This option has the following values:|
- Preferred - (this is the default). Use SSL if the server supports it.
- None - Do not use SSL.
- Required - Always use SSL. Deny connection if server does not support SSL. Does not validate CA or hostname.
- VerifyCA - Always use SSL. Validates the CA but tolerates hostname mismatch.
- VerifyFull - Always use SSL. Validates CA and hostname.
|Certificate File, CertificateFile||Specifies the path to a certificate file in PKCS #12 (.pfx) format containing a bundled Certificate and Private Key used for Mutual Authentication. To create a PKCS #12 bundle from a PEM encoded Certificate and Key, use |
openssl pkcs12 -in cert.pem -inkey key.pem -export -out bundle.pfx. This option should not be specified if
SslKey are used.
|Certificate Password, CertificatePassword||Specifies the password for the certificate specified using the |
CertificateFile option. Not required if the certificate file is not password protected.
|SslCert, Ssl-Cert||Specifies the path to the client’s SSL certificate file in PEM format. |
SslKey must also be specified, and
CertificateFile should not be. This option is not supported on the
|SslKey, Ssl-Key||Specifies the path to the client’s SSL private key in PEM format. |
SslCert must also be specified, and
CertificateFile should not be.
|CA Certificate File, CACertificateFile, SslCa, Ssl-Ca||This option specifies the path to a CA certificate file in a PEM Encoded (.pem) format. This should be used with |
SslMode=VerifyFull to enable verification of a CA certificate that is not trusted by the Operating System’s certificate store.
|Certificate Store Location, CertificateStoreLocation||None||Specifies whether the connection should be encrypted with a certificate from the Certificate Store on the machine. The default value of |
None means the certificate store is not used; a value of
LocalMachine uses the specified store.
|Certificate Thumbprint, CertificateThumbprint||Specifies which certificate should be used from the Certificate Store specified in the setting above. This option must be used to indicate which certificate in the store should be used for authentication.|
|Tls Cipher Suites,TlsCipherSuites||Specifies which TLS cipher suites may be used during TLS negotiation. The default value (the empty string) allows the OS to determine the TLS cipher suites to use; this is the recommended setting. Otherwise, specify a comma-delimited list of |
TlsCipherSuite enum values to allow just those cipher suites. (This option is only supported on Linux when using .NET Core 3.1 or .NET 5.0 or later.)
|Tls Version, TlsVersion, Tls-Version||Specifies which TLS versions may be used during TLS negotiation. The default value of |
null allows the OS to determine the TLS version to use (see documentation); this is the recommended setting. Otherwise, to restrict the versions that can be used, specify a comma-delimited list of versions taken from the following:
TLS 1.3. (This option allows each version to be specified in a few different formats:
Tls v1.2; they are treated equivalently.)
Connection pooling is enabled by default. These options are used to configure it.
|Pooling||true||Enables connection pooling. When pooling is enabled, |
OpenAsync retrieves an open connection from the pool if one is available, and
DisposeAsync returns the open connection to the pool. If there are no available connections in the pool, and the pool hasn’t reached
MaximumPoolSize connections, a new connection will be opened; otherwise, the call to
OpenAsync blocks until a connection becomes available or
ConnectionTimeout is reached.
|Connection Lifetime, ConnectionLifeTime||0||Connections that are returned to the pool will be closed if it’s been more than |
ConnectionLifeTime seconds since the connection was created. The default value of zero (0) means pooled connections will never incur a
ConnectionLifeTime timeout. This can be useful when multiple database servers are being used, as it will force existing connections to be closed, which may spread load more evenly.
|Connection Reset, ConnectionReset|
true, all connections retrieved from the pool will have been reset. The default value of
true ensures that the connection is in the same state whether it’s newly created or retrieved from the pool. A value of
false avoids making an additional server round trip to reset the connection, but the connection state is not reset, meaning that session variables and other session state changes from any previous use of the connection are carried over.
|Connection Idle Ping Time, ConnectionIdlePingTime (Experimental)||0||When a connection is retrieved from the pool, and |
false, the server
will be pinged if the connection has been idle in the pool for longer than
If pinging the server fails, a new connection will be opened automatically by the connection pool. This ensures that the
MySqlConnection is in a valid, open state after the call to
at the cost of an extra server roundtrip. For high-performance scenarios, you may wish to set
to a non-zero value to make the connection pool assume that recently-returned connections are still open. If the
connection is broken, it will throw from the first call to
etc.; your code should handle that failure and retry the connection. This option has no effect if
true, as that will cause a connection reset packet to be sent to the server, making ping redundant.
|Connection Idle Timeout, ConnectionIdleTimeout||180||The amount of time (in seconds) that a connection can remain idle in the pool. Any connection above |
MinimumPoolSize connections that is idle for longer than
ConnectionIdleTimeout is subject to being closed by a background task. The background task runs every minute, or half of
ConnectionIdleTimeout, whichever is more frequent. A value of zero (0) means pooled connections will never incur a ConnectionIdleTimeout, and if the pool grows to its maximum size, it will never get smaller.
|Defer Connection Reset, DeferConnectionReset|
true, the connection state is not reset until the connection is retrieved from the pool. This was the default behaviour before MySqlConnector 1.3. The default value of
false resets connections in the background after they’re closed which makes opening a connection faster, and releases server resources sooner.
|Maximum Pool Size, Max Pool Size, MaximumPoolsize, maxpoolsize||100||The maximum number of connections allowed in the pool.|
|Minimum Pool Size, Min Pool Size, MinimumPoolSize, minpoolsize||0||The minimum number of connections to leave in the pool if ConnectionIdleTimeout is reached.|
These are the other options that MySqlConnector supports. They are set to sensible defaults and typically do not need to be tweaked.
|AllowLoadLocalInfile, Allow Load Local Infile||false||Allows the |
LOAD DATA LOCAL command to request files from the client. This is disabled by
default as a security precaution.
In order to use
MySqlBulkLoader and set its
Local property to
must set this option to
True in your connection string.
|AllowPublicKeyRetrieval, Allow Public Key Retrieval||false||If the user account uses |
sha256_password authentication, the password must be protected during transmission; TLS is the preferred mechanism for this,
but if it is not available then RSA public key encryption will be used. To specify the server’s RSA public key, use the
string setting, or set
AllowPublicKeyRetrieval=True to allow the client to automatically request the public key from the server. Note that
could allow a malicious proxy to perform a MITM attack to get the plaintext password, so it is
False by default and must be explicitly enabled.
|AllowUserVariables, Allow User Variables||false||Allows user-defined variables (prefixed with |
@) to be used in SQL statements. The default value (
@-prefixed names to refer to command parameters.
|AllowZeroDateTime, Allow Zero DateTime||false||If set to true all |
TIMESTAMP columns are returned as
MySqlDateTime objects instead of
This allows the special “zero” date value
0000-00-00 to be retrieved from the database. If
false (the default)
date columns are returned as
DateTime values, and an exception is thrown for unrepresentable dates.
|ApplicationName, Application Name||null||Sets the program_name connection attribute passed to MySQL Server. This value may be displayed by diagnostic tools,
e.g., as the “Program” column in “Client Connections” in MySQL Workbench.|
|AutoEnlist, Auto Enlist||true||If |
MySqlConnection will detect if there is an active
TransactionScope when it's opened and automatically enlist in it. If
false, connections must be manually enlisted by calling
|CancellationTimeout, Cancellation Timeout||2||The length of time (in seconds) to wait for a query to be canceled when |
MySqlCommand.CommandTimeout expires, or zero for no timeout. If a response isn’t received from the server in this
time, the local socket will be closed and a
MySqlException will be thrown.
|CharSet, Character Set, CharacterSet||utf8mb4||MySqlConnector always uses |
utf8mb4 to send and receive strings from MySQL Server. This option may be specified (for backwards compatibility) but it will be ignored.
|Compress, Use Compression, UseCompression||false||If true (and if the server supports compression), compresses packets sent between client and server. This option is unlikely to be useful in
practice unless there is a high-latency or low-bandwidth network link between the application and the database server. You should measure
performance with and without this option to determine if it’s beneficial in your environment.|
|Connect Timeout, Connection Timeout, ConnectionTimeout||15||The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error.|
|Convert Zero Datetime, ConvertZeroDateTime||false||True to have |
DateTime.MinValue for date or datetime columns that have disallowed values.
DateTimeKind used when
MySqlDataReader returns a
DateTime. If set to
MySqlException will be thrown if a
DateTime command parameter has a
Determines which column type (if any) should be read as a
The options include:
CHAR(36) columns are read/written as a
Guid using lowercase hex with hyphens, which matches
CHAR(32) columns are read/written as a
Guid using lowercase hex without hyphens.
BINARY(16) columns are read/written as a
Guid using big-endian byte order, which matches
BINARY(16) columns are read/written as a
Guid using big-endian byte order with time parts swapped, which matches
BINARY(16) columns are read/written as a
Guid using little-endian byte order, i.e. the byte order used by
Guid.ToByteArray() and the
- No column types are automatically read as a
- Same as
OldGuids=False; same as
|Default Command Timeout, Command Timeout, DefaultCommandTimeout||30||The length of time (in seconds) each command can execute before the query is cancelled on the server, or zero to disable timeouts.
See the note in the Microsoft documentation
for more explanation of how this is determined.|
|IgnoreCommandTransaction, Ignore Command Transaction||false||If |
true, the value of
MySqlCommand.Transaction is ignored when commands are executed.
This matches the Connector/NET behaviour and can make porting code easier. For more information, see Transaction Usage.
|IgnorePrepare, Ignore Prepare||false||If |
true, calls to
MySqlCommand.Prepare(Async) are ignored (and will be no-ops).
This option is provided for backwards compatibility with MySQL Connector/NET (before 8.0.23) and should not be used.
|Interactive, Interactive Session, InteractiveSession||false||If |
true, the session
wait_timeout variable is initialized from the global
value instead of the global
|Keep Alive, Keepalive||0|
TCP Keepalive idle time (in seconds). A value of 0 indicates that the OS Default keepalive settings are used; a value greater than 0 is the idle connection time (in seconds) before the first keepalive packet is sent.
On Windows, this option is always supported. On non-Windows platforms, this option only takes effect in .NET Core 3.0 and later. For earlier versions of .NET Core, the OS Default keepalive settings are used instead.
|Load Balance, LoadBalance||RoundRobin|
The load-balancing strategy to use when
Host contains multiple, comma-delimited, host names.
The options include:
- Each new connection opened for this connection pool uses the next host name (sequentially with wraparound). Requires
Pooling=True. This is the default if
- Each new connection tries to connect to the first host; subsequent hosts are used only if connecting to the first one fails. This is the default if
- Servers are tried in a random order.
- Servers are tried in ascending order of number of currently-open connections in this connection pool. Requires
|No Backslash Escapes, NoBackslashEscapes||false||If |
true, backslashes are not escaped in string parameters. Set this to
true if the server’s SQL mode includes
|Old Guids, OldGuids||false||Obsolete; use the |
GuidFormat option instead.
|Persist Security Info, PersistSecurityInfo||false||When set to |
false or no (strongly recommended), security-sensitive information, such as the password, is not returned as part of the connection string if the connection is open or has ever been in an open state. Resetting the connection string resets all connection string values, including the password. Recognized values are true, false, yes, and no.
|ServerRedirectionMode, Server Redirection Mode||Disabled|
Whether to use server redirection. The options include:
- Server redirection is not used. All connections go through the proxy server (if there is one).
- If the server supports redirection, a redirected connection will be attempted. If it’s successful, the redirected connection will be used; otherwise, the original connection will be used.
- The server must support redirection, and making a redirected connection must be successful; otherwise, an exception will be thrown.
Server Redirection is supported by Azure Database for MySQL if the
redirect_enabled server parameter is set to
This option is only respected if
|ServerRsaPublicKeyFile, Server RSA Public Key File||For |
sha256_password authentication. See comments under
|ServerSPN, Server SPN||For MariaDB |
auth_gssapi_client authentication. Specifies the server’s Service Principal Name (to verify that authentication is occurring with the correct server).
|Treat Tiny As Boolean, TreatTinyAsBoolean||true||When set to |
TINYINT(1) values are returned as booleans. Setting this to
TINYINT(1) to be returned as sbyte/byte.
|Use Affected Rows, UseAffectedRows||false||When |
false (default), the connection reports found rows instead of changed (affected) rows. Set to
true to report only the number of rows actually changed by
INSERT … ON DUPLICATE KEY UPDATE statements.
|Use XA Transactions, UseXaTransactions||true||When |
true (default), using
will use a XA Transaction. This allows true
distributed transactions, but may not be compatible with server replication; there are other limitations.
When set to
false, regular MySQL transactions are used, just like Connector/NET.
These options are used by Connector/NET but not supported by MySqlConnector. In general, they should be removed
from your connection string when migrating from Connector/NET to MySqlConnector.
|AllowBatch, Allow Batch||true||MySqlConnector always allows batch statements.|
|CacheServerProperties, Cache Server Properties||MySqlConnector doesn’t need this optimization.|
|CheckParameters, Check Parameters||true||MySqlConnector always checks stored procedure parameters efficiently; there’s no need to disable this.|
|CommandInterceptors, Command Interceptors||MySqlConnector doesn’t support this extensibility mechanism, which is not compatible with async operations.|
|DnsSrv, Dns-Srv||MySqlConnector doesn’t support discovering server addresses from DNS SRV records.|
|ExceptionInterceptors, Exception Interceptors||MySqlConnector doesn’t support this extensibility mechanism.|
|FunctionsReturnString, Functions Return String||false||Not supported. BLOBs are always returned as |
|IncludeSecurityAsserts, Include Security Asserts||false||Not supported. For partial trust environments.|
|IntegratedSecurity, Integrated Security||false||Windows authentication is not supported.|
|Logging||false||Use MySqlConnector logging (which is more flexible) instead.|
|OldSyntax, Old Syntax, UseOldSyntax, Use Old Syntax||false||This option is deprecated in Connector/NET and unsupported in MySqlConnector.|
|ProcedureCacheSize, Procedure Cache Size, ProcedureCache, Procedure Cache||MySqlConnector places no limit on the amount of stored procedure metadata that is cached. It takes a very small amount of memory.|
|RespectBinaryFlags, Respect Binary Flags||true||The binary type of a column is always respected.|
|SharedMemoryName, Shared Memory Name||true||Shared memory (on Windows) is not supported as a connection protocol.|
|SshHostName, SshPort, SshUserName, SshPassword, SshKeyFile, SshPassPhrase||Connecting via SSH isn’t built into MySqlConnector, but can be set up easily by following these instructions.|
|SqlServerMode, Sql Server Mode||false||Not supported.|
|TreatBlobsAsUtf8, Treat BLOBs as UTF8||false||Not supported. BLOBs are always returned as |
|UsePerformanceMonitor, Use Performance Monitor, UserPerfMon, PerfMon||false||Not supported.|
|UseUsageAdvisor, Use Usage Advisor, Usage Advisor||false||Not supported.|