SqlConnection.ConnectionString Property

Definition

Namespace:

Microsoft.Data.SqlClient

Assembly:

Microsoft.Data.SqlClient.dll

Package:

Microsoft.Data.SqlClient v5.2.0

Gets or sets the string used to open a SQL Server database.

public:
 virtual property System::String ^ ConnectionString { System::String ^ get(); void set(System::String ^ value); };

[System.ComponentModel.SettingsBindable(true)]
public override string ConnectionString { get; set; }

[<System.ComponentModel.SettingsBindable(true)>]
member this.ConnectionString : string with get, set

Public Overrides Property ConnectionString As String

Property Value

String

The connection string that includes the source database name, and other parameters needed to establish the initial connection. The default value is an empty string.

Attributes

SettingsBindableAttribute

Exceptions

ArgumentException

An invalid connection string argument has been supplied, or a required connection string argument has not been supplied.

Examples

The following example creates a SqlConnection and sets the ConnectionString property before opening the connection.

using Microsoft.Data.SqlClient;

class Program
{
    static void Main()
    {
        OpenSqlConnection();
        Console.ReadLine();
    }

    private static void OpenSqlConnection()
    {
        string connectionString = GetConnectionString();

        using (SqlConnection connection = new SqlConnection())
        {
            connection.ConnectionString = connectionString;

            connection.Open();

            Console.WriteLine("State: {0}", connection.State);
            Console.WriteLine("ConnectionString: {0}",
                connection.ConnectionString);
        }
    }

    static private string GetConnectionString()
    {
        // To avoid storing the connection string in your code, 
        // you can retrieve it from a configuration file.
        return "Data Source=MSSQL1;Initial Catalog=AdventureWorks;"
            + "Integrated Security=true;";
    }
}

Remarks

The ConnectionString is similar to an OLE DB connection string, but is not identical. Unlike OLE DB or ADO, the connection string that is returned is the same as the user-set ConnectionString, minus security information if the Persist Security Info value is set to false (default). The .NET Framework Data Provider for SQL Server does not persist or return the password in a connection string unless you set Persist Security Info to true.
You can use the ConnectionString property to connect to a database. The following example illustrates a typical connection string.

"Persist Security Info=False;Integrated Security=true;Initial Catalog=Northwind;server=(local)"  

Use the new SqlConnectionStringBuilder to construct valid connection strings at run time. For more information, see Connection String Builders.

The ConnectionString property can be set only when the connection is closed. Many of the connection string values have corresponding read-only properties. When the connection string is set, these properties are updated, except when an error is detected. In this case, none of the properties are updated. SqlConnection properties return only those settings that are contained in the ConnectionString.

To connect to a local computer, specify "(local)" for the server. If a server name is not specified, a connection will be attempted to the default instance on the local computer.

Resetting the ConnectionString on a closed connection resets all connection string values (and related properties) including the password. For example, if you set a connection string that includes "Database= AdventureWorks", and then reset the connection string to "Data Source=myserver;Integrated Security=true", the Database property is no longer set to "AdventureWorks".

The connection string is parsed immediately after being set. If errors in syntax are found when parsing, a runtime exception, such as ArgumentException, is generated. Other errors can be found only when an attempt is made to open the connection.

The basic format of a connection string includes a series of keyword/value pairs separated by semicolons. The equal sign (=) connects each keyword and its value. To include values that contain a semicolon, single-quote character, or double-quote character, the value must be enclosed in double quotation marks. If the value contains both a semicolon and a double-quote character, the value can be enclosed in single quotation marks. The single quotation mark is also useful if the value starts with a double-quote character. Conversely, the double quotation mark can be used if the value starts with a single quotation mark. If the value contains both single-quote and double-quote characters, the quotation mark character used to enclose the value must be doubled every time it occurs within the value.

To include preceding or trailing spaces in the string value, the value must be enclosed in either single quotation marks or double quotation marks. Any leading or trailing spaces around integer, Boolean, or enumerated values are ignored, even if enclosed in quotation marks. However, spaces within a string literal keyword or value are preserved. Single or double quotation marks may be used within a connection string without using delimiters (for example, Data Source= my'Server or Data Source= my"Server), unless a quotation mark character is the first or last character in the value.

Keywords are not case sensitive.

The following table lists the valid names for keyword values within the ConnectionString.

Keyword	Default	Description
Addr	N/A	Synonym of Data Source.
Address	N/A	Synonym of Data Source.
App	N/A	Synonym of Application Name.
Application Intent -or- ApplicationIntent	ReadWrite	Declares the application workload type when connecting to a server. Possible values are ReadOnly and ReadWrite. For example: ApplicationIntent=ReadOnly For more information about SqlClient support for Always On Availability Groups, see SqlClient Support for High Availability, Disaster Recovery.
Application Name	N/A	The name of the application. If no application name is provided, 'Framework Microsoft SqlClient Data Provider' when running on .NET Framework and 'Core Microsoft SqlClient Data Provider' otherwise. An application name can be 128 characters or less.
AttachDBFilename -or- Extended Properties -or- Initial File Name	N/A	The name of the primary database file, including the full path name of an attachable database. AttachDBFilename is only supported for primary data files with an .mdf extension. If the value of the AttachDBFileName key is specified in the connection string, the database is attached and becomes the default database for the connection. If this key is not specified and if the database was previously attached, the database will not be reattached. The previously attached database will be used as the default database for the connection. If this key is specified together with the AttachDBFileName key, the value of this key will be used as the alias. However, if the name is already used in another attached database, the connection will fail. The path may be absolute or relative by using the DataDirectory substitution string. If DataDirectory is used, the database file must exist within a subdirectory of the directory pointed to by the substitution string. Note: Remote server, HTTP, and UNC path names are not supported. The database name must be specified with the keyword 'database' (or one of its aliases) as in the following: "AttachDbFileName=|DataDirectory|\data\YourDB.mdf;integrated security=true;database=YourDatabase" An error will be generated if a log file exists in the same directory as the data file and the 'database' keyword is used when attaching the primary data file. In this case, remove the log file. Once the database is attached, a new log file will be automatically generated based on the physical path.
Attestation Protocol	NotSpecified	Gets or sets the value of Attestation Protocol. When no value is specified, secure enclaves are disabled on the connection. Valid values are: AAS HGS None (Only valid in v3.1 and v4.1+))
Authentication	N/A	The authentication method used for Connecting to SQL Database By Using Azure Active Directory Authentication. Valid values are: Active Directory Integrated, Active Directory Interactive, Active Directory Password, Active Directory Service Principal, Active Directory Device Code Flow, Active Directory Managed Identity, Active Directory MSI, Active Directory Default, Sql Password. For additional information see Using Azure Active Directory authentication with SqlClient.
Column Encryption Setting	disabled	Enables or disables Always Encrypted functionality for the connection. Supported values are: enabled and disabled
Command Timeout	30	The default wait time (in seconds) before terminating the attempt to execute a command and generating an error. Valid values are greater than or equal to 0 and less than or equal to 2147483647.
Connect Retry Count -or- ConnectRetryCount	1	Controls the number of reconnection attempts after the client identifies an idle connection failure. Valid values are 0 to 255. 0 means do not attempt to reconnect (disable connection resiliency). Note: Since version 5.x the default value for non Azure endpoints is 1. For Azure SQL endpoints, the default is 2. For Azure SQL serverless or on demand endpoints, the default is 5 to improve connection success for connections to an idle or paused instance. For additional information about idle connection resiliency, see .NET SqlConnection parameters for connection retry and Technical Article - Idle Connection Resiliency.
Connect Retry Interval -or- ConnectRetryInterval	10	Specifies the time between each connection retry attempt (ConnectRetryCount). Valid values are 1 to 60 seconds (default=10), applied after the first reconnection attempt. When a broken connection is detected, the client immediately attempts to reconnect; this is the first reconnection attempt and only occurs if ConnectRetryCount is greater than 0. If the first reconnection attempt fails and ConnectRetryCount is greater than 1, the client waits ConnectRetryInterval to try the second and subsequent reconnection attempts. For additional information about idle connection resiliency, see.NET SqlConnection parameters for connection retry and Technical Article - Idle Connection Resiliency.
Connect Timeout -or- Connection Timeout -or- Timeout	15	The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error. Valid values are greater than or equal to 0 and less than or equal to 2147483647. When opening a connection to a Azure SQL Database, set the connection timeout to 30 seconds.
Current Language -or- Language	N/A	Sets the language used for database server warning or error messages. The language name can be 128 characters or less.
Data Source -or- Server -or- Address -or- Addr -or- Network Address	N/A	The name or network address of the instance of SQL Server to which to connect. The port number can be specified after the server name: server=tcp:servername, portnumber When specifying a local instance, always use (local). To force a protocol, add one of the following prefixes: np:(local), tcp:(local), lpc:(local) You can also connect to a LocalDB database as follows: server=(localdb)\\myInstance For more information about LocalDB, see SqlClient Support for LocalDB. Data Source must use the TCP format or the Named Pipes format. TCP format is as follows: - tcp:<host name>\<instance name> - tcp:<host name>,<TCP/IP port number> The TCP format must start with the prefix "tcp:" and is followed by the database instance, as specified by a host name and an instance name. This format is not applicable when connecting to Azure SQL Database. TCP is automatically selected for connections to Azure SQL Database when no protocol is specified. The host name MUST be specified in one of the following ways: - NetBIOSName - IPv4Address - IPv6Address The instance name is used to resolve to a particular TCP/IP port number on which a database instance is hosted. Alternatively, specifying a TCP/IP port number directly is also allowed. If both instance name and port number are not present, the default database instance is used. The Named Pipes format is as follows: - np:\\<host name>\pipe\<pipe name> The Named Pipes format MUST start with the prefix "np:" and is followed by a named pipe name. The host name MUST be specified in one of the following ways: - NetBIOSName - IPv4Address - IPv6Address The pipe name is used to identify the database instance to which the .NET application will connect. If the value of the Network key is specified, the prefixes "tcp:" and "np:" should not be specified. Note: You can force the use of TCP instead of shared memory, either by prefixing tcp: to the server name in the connection string, or by using localhost.
Enclave Attestation Url	N/A	Gets or sets the enclave attestation URL to be used with enclave based Always Encrypted.
Encrypt	'true' in 4.0 and above 'false' in 3.x and below	Recognized values are: versions 1 - 4: true/yes and false/no versions 5+: true/yes/mandatory, false/no/optional and strict. When true, TLS encryption is used for all data sent between the client and server if the server has a certificate installed. When strict, TDS 8.0 TLS encryption is used and the TrustServerCertificate setting is ignored and treated as false. For more information, see Connection String Syntax. When Encrypt is mandatory or strict and TrustServerCertificate is false, the server name (or IP address) in a server's certificate must exactly match the server name (or IP address) specified in the connection string. Otherwise, the connection attempt will fail.
Enlist	'true'	true indicates that the SQL Server connection pooler automatically enlists the connection in the creation thread's current transaction context.
Failover Partner	N/A	The name of the failover partner server where database mirroring is configured. If the value of this key is "", then Initial Catalog must be present, and its value must not be "". The server name can be 128 characters or less. If you specify a failover partner but the failover partner server is not configured for database mirroring and the primary server (specified with the Server keyword) is not available, then the connection will fail. If you specify a failover partner and the primary server is not configured for database mirroring, the connection to the primary server (specified with the Server keyword) will succeed if the primary server is available.
Failover Partner SPN -or- FailoverPartnerSPN	N/A	The SPN for the failover partner. The default value is an empty string, which causes SqlClient to use the default, driver-generated SPN. (Only available in v5.0+)
Host Name In Certificate -or- HostNameInCertificate	N/A	The host name to use when validating the server certificate. When not specified, the server name from the Data Source is used for certificate validation. (Only available in v5.0+)
Server Certificate -or- ServerCertificate	N/A	The path to a certificate file to match against the SQL Server TLS/SSL certificate. The accepted certificate formats are PEM, DER, and CER. If specified, the SQL Server certificate is checked by verifying if the ServerCertificate provided is an exact match. (Only available in v5.1+)
Initial Catalog -or- Database	N/A	The name of the database. The database name can be 128 characters or less.
Integrated Security -or- Trusted_Connection	'false'	When false, User ID and Password are specified in the connection. When true, the current Windows account credentials are used for authentication. Recognized values are true, false, yes, no, and sspi (strongly recommended), which is equivalent to true. If User ID and Password are specified and Integrated Security is set to true, the User ID and Password will be ignored and Integrated Security will be used. SqlCredential is a more secure way to specify credentials for a connection that uses SQL Server Authentication (Integrated Security=false).
IP Address Preference -or- IPAddressPreference	IPv4First	The IP address family preference when establishing TCP connections. If Transparent Network IP Resolution (in .NET Framework) or Multi Subnet Failover is set to true, this setting has no effect. Supported values include: IPAddressPreference=IPv4First IPAddressPreference=IPv6First IPAddressPreference=UsePlatformDefault
Load Balance Timeout -or- Connection Lifetime	0	When a connection is returned to the pool, its creation time is compared with the current time, and the connection is destroyed if that time span (in seconds) exceeds the value specified by Connection Lifetime. This is useful in clustered configurations to force load balancing between a running server and a server just brought online. A value of zero (0) causes pooled connections to have the maximum connection timeout.
Max Pool Size	100	The maximum number of connections that are allowed in the pool. Valid values are greater than or equal to 1. Values that are less than Min Pool Size generate an error.
Min Pool Size	0	The minimum number of connections that are allowed in the pool. Valid values are greater than or equal to 0. Zero (0) in this field means no minimum connections are initially opened. Values that are greater than Max Pool Size generate an error.
Multiple Active Result Sets -or- MultipleActiveResultSets	false	When true, an application can maintain multiple active result sets (MARS). When false, an application must process or cancel all result sets from one batch before it can execute any other batch on that connection. Recognized values are true and false. For more information, see Multiple Active Result Sets (MARS).
Multi Subnet Failover -or- MultiSubnetFailover	false	Always specify multiSubnetFailover=True when connecting to the availability group listener of a SQL Server 2012 (or later) availability group or a SQL Server 2012 (or later) Failover Cluster Instance. multiSubnetFailover=True configures SqlClient to provide faster detection of and connection to the (currently) active server. Possible values are Yes and No, True and False or 1 and 0. For example: MultiSubnetFailover=True The default is False. For more information about SqlClient's support for Always On AGs, see SqlClient Support for High Availability, Disaster Recovery.
Network Library -or- Network -or- Net	N/A	The network library used to establish a connection to an instance of SQL Server. Supported values include: dbnmpntw (Named Pipes) dbmsrpcn (Multiprotocol, Windows RPC) dbmsadsn (Apple Talk) dbmsgnet (VIA) dbmslpcn (Shared Memory) dbmsspxn (IPX/SPX) dbmssocn (TCP/IP) Dbmsvinn (Banyan Vines) The corresponding network DLL must be installed on the system to which you connect. If you do not specify a network and you use a local server (for example, "." or "(local)"), shared memory is used. In this example, the network library is Win32 Winsock TCP/IP (dbmssocn), and 1433 is the port being used. Network Library=dbmssocn;Data Source=000.000.000.000,1433;
Packet Size	8000	Size in bytes of the network packets used to communicate with an instance of SQL Server. The packet size can be greater than or equal to 512 and less than or equal to 32768.
Password -or- PWD	N/A	The password for the SQL Server account logging on. Not recommended. To maintain a high level of security, we strongly recommend that you use the Integrated Security or Trusted_Connection keyword instead. SqlCredential is a more secure way to specify credentials for a connection that uses SQL Server Authentication. The password must be 128 characters or less.
Persist Security Info -or- PersistSecurityInfo	'false'	When set to false or no (strongly recommended), security-sensitive information, such as the password or access token, is not returned as part of the connection if the connection is open or has ever been in an open state. This property should only be set to true if your application has a specific need to read the password out of an already-opened database connection. The default value of false is the more secure setting; using true for this property opens your application to security risks such as accidentally logging or tracing the database password. Resetting the connection string resets all connection string values including the password. Recognized values are true, false, yes, and no.
Pool Blocking Period -or- PoolBlockingPeriod	Auto	Sets the blocking period behavior for a connection pool. See PoolBlockingPeriod property for details.
Pooling	'true'	When the value of this key is set to true, any newly created connection will be added to the pool when closed by the application. In a next attempt to open the same connection, that connection will be drawn from the pool. Connections are considered the same if they have the same connection string. Different connections have different connection strings. The value of this key can be "true", "false", "yes", or "no".
Replication	'false'	true if replication is supported using the connection.
Server SPN -or- ServerSPN	N/A	The SPN for the data source. The default value is an empty string, which causes SqlClient to use the default, driver-generated SPN. (Only available in v5.0+)
Transaction Binding	Implicit Unbind	Controls connection association with an enlisted System.Transactions transaction. Possible values are: Transaction Binding=Implicit Unbind; Transaction Binding=Explicit Unbind; Implicit Unbind causes the connection to detach from the transaction when it ends. After detaching, additional requests on the connection are performed in autocommit mode. The System.Transactions.Transaction.Current property is not checked when executing requests while the transaction is active. After the transaction has ended, additional requests are performed in autocommit mode. If the system ends the transaction (in the scope of a using block) before the last command completes, it will throw InvalidOperationException. Explicit Unbind causes the connection to remain attached to the transaction until the connection is closed or an explicit SqlConnection.TransactionEnlist(null) is called. Beginning in .NET Framework 4.0, changes to Implicit Unbind make Explicit Unbind obsolete. An InvalidOperationException is thrown if Transaction.Current is not the enlisted transaction or if the enlisted transaction is not active.
Transparent Network IP Resolution -or- TransparentNetworkIPResolution	See description.	When the value of this key is set to true, the application is required to retrieve all IP addresses for a particular DNS entry and attempt to connect with the first one in the list. If the connection is not established within 0.5 seconds, the application will try to connect to all others in parallel. When the first answers, the application will establish the connection with the respondent IP address. If the MultiSubnetFailover key is set to true, TransparentNetworkIPResolution is ignored. If the Failover Partner key is set, TransparentNetworkIPResolution is ignored. The value of this key must be true, false, yes, or no. A value of yes is treated the same as a value of true. A value of no is treated the same as a value of false. The default values are as follows: false when: Connecting to Azure SQL Database where the data source ends with: .database.chinacloudapi.cn .database.usgovcloudapi.net .database.cloudapi.de .database.windows.net Authentication is 'Active Directory Password' or 'Active Directory Integrated' true in all other cases.
Trust Server Certificate -or- TrustServerCertificate	'false'	When set to true, TLS is used to encrypt the channel when bypassing walking the certificate chain to validate trust. If TrustServerCertificate is set to true and Encrypt is set to false, the channel is not encrypted. Recognized values are true, false, yes, and no. For more information, see Connection String Syntax.
Type System Version	N/A	A string value that indicates the type system the application expects. The functionality available to a client application is dependent on the version of SQL Server and the compatibility level of the database. Explicitly setting the type system version that the client application was written for avoids potential problems that could cause an application to break if a different version of SQL Server is used. Note: The type system version cannot be set for common language runtime (CLR) code executing in-process in SQL Server. For more information, see SQL Server Common Language Runtime Integration. Possible values are: Type System Version=SQL Server 2012; Type System Version=SQL Server 2008; Type System Version=SQL Server 2005; Type System Version=Latest; Type System Version=SQL Server 2012; specifies that the application will require version 11.0.0.0 of Microsoft.SqlServer.Types.dll. The other Type System Version settings will require version 10.0.0.0 of Microsoft.SqlServer.Types.dll. Latest is obsolete and should not be used. Latest is equivalent to Type System Version=SQL Server 2008;.
User ID -or- UID -or- User	N/A	The SQL Server login account. Not recommended. To maintain a high level of security, we strongly recommend that you use the Integrated Security or Trusted_Connection keywords instead. SqlCredential is a more secure way to specify credentials for a connection that uses SQL Server Authentication. The user ID must be 128 characters or less.
User Instance	'false'	A value that indicates whether to redirect the connection from the default SQL Server Express instance to a runtime-initiated instance running under the account of the caller.
Workstation ID -or- WSID	The local computer name	The name of the workstation connecting to SQL Server. The ID must be 128 characters or less.

The following list contains the valid names for connection pooling values within the ConnectionString. For more information, see SQL Server Connection Pooling (ADO.NET).

• Connection Lifetime (or Load Balance Timeout)

• Enlist

• Max Pool Size

• Min Pool Size

• Pooling

When you are setting keyword or connection pooling values that require a Boolean value, you can use 'yes' instead of 'true', and 'no' instead of 'false'. Integer values are represented as strings.

Note

The .NET Framework Data Provider for SQL Server uses its own protocol to communicate with SQL Server. Therefore, it does not support the use of an ODBC data source name (DSN) when connecting to SQL Server because it does not add an ODBC layer.

Note

Universal data link (UDL) files are not supported for the .NET Framework Data Provider for SQL Server.

Caution

In this release, the application should use caution when constructing a connection string based on user input (for example when retrieving user ID and password information from a dialog box, and appending it to the connection string). The application should make sure that a user cannot embed additional connection string parameters in these values (for example, entering a password as "validpassword;database=somedb" in an attempt to attach to a different database). If you need to construct connection strings based on user input, use the new SqlConnectionStringBuilder, which validates the connection string and helps to eliminate this problem. See Connection String Builders for more information.