Friday, March 15, 2013

MySQL Connection String

Connection strings for MySQL

.NET libraries for MySQL

  • MySQL Connector/Net - MySqlConnection
  • eInfoDesigns.dbProvider - MySqlConnection
  • SevenObjects MySqlClient
  • dotConnect for MySQL (former MyDirect.NET and Core Labs MySQLDirect.NET) - MySqlConnection
  • MySQLDriverCS - MySQLConnection
  • .NET Framework Data Provider for OLE DB - OleDbConnection
  • .NET Framework Data Provider for ODBC - OdbcConnection

OLE DB providers for MySQL

ODBC drivers for MySQL

MySQL Connector/Net

Type .NET Framework Class Library Usage MySql.Data.MySqlClient.MySqlConnection Manufacturer MySQL
More info and class library downloads

Set example values

Standard

Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword; 

Specifying TCP port

    
Server=myServerAddress;Port=1234;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
The port 3306 is the default MySql port.
The value is ignored if Unix socket is used.
 

Multiple servers

Use this to connect to a server in a replicated server configuration without concern on which server to use.
    
Server=serverAddress1, serverAddress2, serverAddress3;Database=myDataBase;
Uid=myUsername;Pwd=myPassword;
 

Using encryption (old)

This one activates SSL encryption for all data sent between the client and server. The server must have a certificate installed.
    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;Encrypt=true;
This option is available for Connector/NET version 5.0.3 through 6.2.1. From 6.2.1 use the SslMode option instead.
 

Using encryption (new)

Use SSL if the server supports it, but allow connection in all cases
    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
SslMode=Preferred;
This option is available from Connector/NET version 6.2.1
 

Force encryption

Always use SSL. Deny connection if server does not support SSL.
    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
SslMode=Required;
This option is available from Connector/NET version 6.2.1
 

SSL with a file-based certificate

    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
SSL Mode=Required;CertificateFile=C:\folder\client.pfx;CertificatePassword=pass;
This option is available from Connector/NET version 6.2.1
 

SSL with a personal store-based certificate

    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
SSL Mode=Required;Certificate Store Location=CurrentUser;
This option is available from Connector/NET version 6.2.1
 

SSL with a thumbprint specific personal store-based certificate

    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
SSL Mode=Required;Certificate Store Location=CurrentUser;
Certificate Thumbprint=479436009a40f3017a145cf8479e7694d7aadef0;
This option is available from Connector/NET version 6.2.1
 

Disallow batches

    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
AllowBatch=False;
 

Allow User Variables

    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
AllowUserVariables=True;
This option is available from Connector/NET version 5.2.2
 

Invalid DateTime's 1

    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
AllowZeroDateTime=True;
Returns a MySqlDateTime object for invalid values and a System.DateTime object for valid values.
 

Invalid DateTime's 2

    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
ConvertZeroDateTime=True;
Returns System.DateTime.MinValue valued System.DateTime object for invalid values and a System.DateTime object for valid values.
 

Disable transaction participation

The use of auto enlist transactionscope (default behaviour) could cause trouble in medium trust environments.
    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
AutoEnlist=False;
 

Skip parameter checks for stored routines

Default behaviour is that parameters for stored routines (stored procedures) are checked against the server
    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
CheckParameters=False;
Some permissions and value casting related errors reported fixed when using this connection option.
 

Skip parameter type and order matching for stored procedures

    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
UseProcedureBodies=False;
The default behaviour is to read tables mysql.proc/INFORMATION_SCHEMA.ROUTINES and try to map provided command parameter values to the called procedures parameters and type cast values accordingly.
This can be troublesome if permissions to the (aforementioned) sproc info tables are insufficient.
The driver will not automatically map the parameters so you must manually set parameter types and you must also make sure to add the parameters to the command object in the exact order as appeared in the procedure definition.
This option is available from Connector/NET version 5.0.4
 

Use Table Caching

    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
tablecache=true;DefaultTableCacheAge=30;
Specifying DefaultTableCacheAge is optional, default value is 60 seconds.
This option is available from Connector/NET version 6.4
 

Count changed rows instead of found rows

    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
UseAffectedRows=True;
This option is available from Connector/NET version 5.2.6
 

Compress network communication between client and server

    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
UseCompression=True;
 

Log inefficient database operations

    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
UseUsageAdvisor=True;
 

Enable performance counters

    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
UsePerformanceMonitor=True;
 

Connection Pooling

From version 6.2 idle connections are removed from the pool, freeing resources on the client (sockets) and the server (sockets and threads). Do not manually keep (global) connections and open close. Keep connection object creation and disposal as tight as possible, this might be counterintuitive but pooling mechanisms will take care of caching well and your code will be cleaner.
    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;Pooling=True;
This is the default behaviour.
 

Connection Pool size

    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
MinimumPoolSize=10;maximumpoolsize=50;
Default values are 0 and 100.
 

Disable connection pooling

    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;Pooling=False;
 

Connection state reset when obtained from pool

    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
ConnectionReset=True;
Makes an additional round trip to the server when obtaining a connection from the pool and connection state will be reset.
 

Recycle connections in pool

This is useful in load balancing scenarios when available servers change you don't want 100 constant connections in the pool pointing to only one server.
    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
ConnectionLifeTime=300;
Specified in seconds, the amount of time after connection object creation the connection will be destroyed. Destruction will only happen when connections are returned to pool.
 

Do not update server settings on connections in pool

A connection might be long lived in the pool, however the connections server settings are updated (SHOW VARIABLES command) each time returned to the pool. This makes the client use of the connection object up to date with the correct server settings. However this causes a round trip and to optimize pooling performance this behaviour can be turned off.
    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
CacheServerProperties=True;
This option is available from Connector/NET version 6.3
 

Use Windows authentication

    
Server=myServerAddress;Database=myDataBase;IntegratedSecurity=yes;Uid=auth_windows;
This option is available from Connector/NET version 6.4.4
The Windows Native Authentication Plugin must be installed for this to work.
 

Keep TCP Sockets alive

    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;Keepalive=10;
Number of seconds between each keep-alive package send.
 

Use BINARY(16) GUIDs

    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;OldGuids=True;
This option is available from Connector/NET version 6.1.1
 

Disable Stored procedure cache

    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
ProcedureCacheSize=0;
The default is 25, meaning that stored procedure meta data (such as input/output data types etc) for the latest 25 called procedures will be cached in client memory.
This option is available from Connector/NET version 5.0.2
 

Allow square brackets around symbols (instead of backticks)

    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
sqlservermode=True;
This enables Visual Studio wizards that bracket symbols with [] to work with Connector/Net. This option incurs a performance hit, so should only be used if necessary.
This option is available from Connector/NET version 6.3.1
 

Specifying default command timeout

Use this one to specify a default command timeout for the connection. Please note that the property in the connection string does not supercede the individual command timeout property on an individual command object.
    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
default command timeout=20;
This option is available from Connector/NET version 5.1.4.
 

Specifying connection attempt timeout

Use this one to specify the length in seconds to wait for a server connection before terminating the attempt and receive an error.
    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
Connection Timeout=5;
 

Inactivating prepared statements

Use this one to instruct the provider to ignore any command prepare statements and prevent corruption issues with server side prepared statements.
    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
Ignore Prepare=true;
The option was added in Connector/NET version 5.0.3 and Connector/NET version 1.0.9.
 

Specifying network protocol

Use this one to specify which network protocol to use for the connection.
    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
Protocol=socket;
"socket" is the default value used if the key isn't specified. Value "tcp" is an equivalent for "socket".
Use "pipe" to use a named pipes connection, "unix" for a Unix socket connection and "memory" to use MySQL shared memory.
 

Shared memory protocol

    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
Protocol=memory;Shared Memory Name=MYSQL;
It's possible to explicit set the shared memory object name used for communication.
 

Named pipes protocol

    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;Protocol=pipe;
PipeName=mypipename;
It's possible to explicit set the pipe name used for communication, if not set, 'mysql' is the default value.
 

Named pipes alternative

    
Server=myServerAddress;Port=-1;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
It is the port value of -1 that tells the driver to use named pipes network protocol. This is available on Windows only. The value is ignored if Unix socket is used.
 

Unix socket connection

    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
Protocol=memory;Shared Memory Name=MYSQL;
It's possible to explicit set the shared memory object name used for communication.
 

Specifying character set

Use this one to specify which character set to use to encode queries sent to the server.
    
Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;CharSet=utf8;
Note! Use lower case value utf8 and not upper case UTF8 as this will fail.
Note that resultsets still are returned in the character set of the data returned.
 

eInfoDesigns.dbProvider

Type .NET Framework Class Library Usage eInfoDesigns.dbProvider.MySqlClient.MySqlConnection Manufacturer eInfoDesigns
More info and class library downloads

Set example values

Standard

    
Data Source=myServerAddress;Database=myDataBase;User ID=myUsername;Password=myPassword;
Command Logging=false;
 

SevenObjects MySqlClient

Type .NET Framework Class Library Usage
Manufacturer SevenObjects
More info and class library downloads

Set example values

Standard

    
Host=myServerAddress;UserName=myUsername;Password=myPassword;Database=myDataBase;
 

dotConnect for MySQL (former MyDirect.NET and Core Labs MySQLDirect.NET)

Type .NET Framework Class Library Usage Devart.Data.MySql.MySqlConnection Manufacturer Devart
More info and class library downloads

Set example values

Standard

    
User ID=root;Password=myPassword;Host=localhost;Port=3306;Database=myDataBase;
Direct=true;Protocol=TCP;Compress=false;Pooling=true;Min Pool Size=0;Max Pool Size=100;
Connection Lifetime=0;
 

MySQLDriverCS

Type .NET Framework Class Library Usage MySQLDriverCS.MySQLConnection Manufacturer MySQLDriverCS project team
More info and class library downloads

Set example values

Standard

    
Location=myServerAddress;Data Source=myDataBase;User ID=myUsername;Password=myPassword;
Port=3306;Extended Properties="""";
 

MySQL OLEDB

Type OLE DB Provider Usage Provider=MySQLProv Manufacturer MySQL
More info and provider downloads

Set example values

Standard

    
Provider=MySQLProv;Data Source=mydb;User Id=myUsername;Password=myPassword;
 

.NET Framework Data Provider for OLE DB

Type .NET Framework Wrapper Class Library Usage System.Data.OleDb.OleDbConnection Manufacturer Microsoft
More info and wrapper class library downloads

Set example values

Use an OLE DB provider from .NET

    
Provider=any oledb provider's name;OledbKey1=someValue;OledbKey2=someValue;
See the respective OLEDB provider's connection strings options. The .net OleDbConnection will just pass on the connection string to the specified OLEDB provider. Read more here.
 

MyODBC 2.50

Type ODBC Driver Usage Driver={mySQL} Manufacturer MySQL
More info and driver downloads

Set example values

Local database

    
Driver={mySQL};Server=localhost;Option=16834;Database=myDataBase;
 

Remote database

    
Driver={mySQL};Server=myServerAddress;Option=131072;Stmt=;Database=myDataBase;
User=myUsername;Password=myPassword;
 

Specifying TCP/IP port

    
Driver={mySQL};Server=myServerAddress;Port=3306;Option=131072;Stmt=;Database=myDataBase;
User=myUsername;Password=myPassword;
The driver defaults to port value 3306, if not specified in the connection string, as 3306 is the default port for MySQL.
 

MySQL Connector/ODBC 3.51

Type ODBC Driver Usage Driver={MySQL ODBC 3.51 Driver} Manufacturer MySQL
More info and driver downloads

Set example values

Local database

    
Driver={MySQL ODBC 3.51 Driver};Server=localhost;Database=myDataBase;User=myUsername;
Password=myPassword;Option=3;
 

Remote database

    
Driver={MySQL ODBC 3.51 Driver};Server=myServerAddress;Database=myDataBase;
User=myUsername;Password=myPassword;Option=3;
 

Specifying TCP/IP port

    
Driver={MySQL ODBC 3.51 Driver};Server=myServerAddress;Port=3306;Database=myDataBase;
User=myUsername;Password=myPassword;Option=3;
The driver defaults to port value 3306, if not specified in the connection string, as 3306 is the default port for MySQL.
 

Specifying character set

    
Driver={MySQL ODBC 3.51 Driver};Server=myServerAddress;charset=UTF8;Database=myDataBase;
User=myUsername;Password=myPassword;Option=3;
Note that the charset option works from version 3.51.17 of the driver.
 

Specifying socket

This one specifies the Unix socket file or Windows named pipe to connect to. Used only for local client connections.
    
Driver={MySQL ODBC 3.51 Driver};Server=myServerAddress;Database=myDataBase;
User=myUsername;Password=myPassword;Socket=MySQL;Option=3;
On Windows, the socket variable is the name of the named pipe that is used for local client connections. The default value is MySQL.
On Unix platforms, the socket variable is the name of the socket file that is used for local client connections. The default is /tmp/mysql.sock.
 

Using SSL

    
Driver={MySQL ODBC 3.51 Driver};Server=myServerAddress;Database=myDataBase;
User=myUsername;Password=myPassword;sslca=c:\cacert.pem;sslcert=c:\client-cert.pem;
sslkey=c:\client-key.pem;sslverify=1;Option=3;
SSLCA specifies the path to a file with a list of trust SSL CAs
SSLCERT specifies the name of the SSL certificate file to use for establishing a secure connection.
SSLKEY specifies the name of the SSL key file to use for establishing a secure connection.
 

MySQL Connector/ODBC 5.1

Type ODBC Driver Usage Driver={MySQL ODBC 5.1 Driver} Manufacturer MySQL
More info and driver downloads

Set example values

Local database

    
Driver={MySQL ODBC 5.1 Driver};Server=localhost;Database=myDataBase;User=myUsername;
Password=myPassword;Option=3;
 

On 64 bit machine

It seems we need to point on MSDASQL for the (32 bit) ODBC driver to work on 64 bit machines.
    
Provider=MSDASQL;Driver={MySQL ODBC 5.1 Driver};Server=localhost;Database=myDataBase;
User=myUsername;Password=myPassword;Option=3;
 

64 bit version of the driver

Note the "w" in the driver name.
    
Driver={MySQL ODBC 5.2w Driver};Server=localhost;Database=myDataBase;User=myUsername;
Password=myPassword;Option=3;
 

Remote database

    
Driver={MySQL ODBC 5.1 Driver};Server=myServerAddress;Database=myDataBase;
User=myUsername;Password=myPassword;Option=3;
 

Specifying TCP/IP port

    
Driver={MySQL ODBC 5.1 Driver};Server=myServerAddress;Port=3306;Database=myDataBase;
User=myUsername;Password=myPassword;Option=3;
The driver defaults to port value 3306, if not specified in the connection string, as 3306 is the default port for MySQL.
 

Specifying character set

    
Driver={MySQL ODBC 5.1 Driver};Server=myServerAddress;charset=UTF8;Database=myDataBase;
User=myUsername;Password=myPassword;Option=3;
 

Specifying socket

This one specifies the Unix socket file or Windows named pipe to connect to. Used only for local client connections.
    
Driver={MySQL ODBC 5.1 Driver};Server=myServerAddress;Database=myDataBase;
User=myUsername;Password=myPassword;Socket=MySQL;Option=3;
On Windows, the socket variable is the name of the named pipe that is used for local client connections. The default value is MySQL.
On Unix platforms, the socket variable is the name of the socket file that is used for local client connections. The default is /tmp/mysql.sock.
 

Using SSL

    
Driver={MySQL ODBC 5.1 Driver};Server=myServerAddress;Database=myDataBase;
User=myUsername;Password=myPassword;sslca=c:\cacert.pem;sslcert=c:\client-cert.pem;
sslkey=c:\client-key.pem;sslverify=1;Option=3;
SSLCA specifies the path to a file with a list of trust SSL CAs
SSLCERT specifies the name of the SSL certificate file to use for establishing a secure connection.
SSLKEY specifies the name of the SSL key file to use for establishing a secure connection.
 

.NET Framework Data Provider for ODBC

Type .NET Framework Wrapper Class Library Usage System.Data.Odbc.OdbcConnection Manufacturer Microsoft
More info and wrapper class library downloads

Set example values

Use an ODBC driver from .NET

    
Driver={any odbc driver's name};OdbcKey1=someValue;OdbcKey2=someValue;
See the respective ODBC driver's connection strings options. The .net OdbcConnection will just pass on the connection string to the specified ODBC driver. Read more here.
at
Labels: , , ,

No comments:

Post a Comment

Subscribe to: Post Comments (Atom)