Provides a simple way to create and manage the contents of connection strings used by the SqlConnection class.
Assembly: System.Data (in System.Data.dll)
Declares the application workload type when connecting to a database in an SQL Server Availability Group. You can set the value of this property with ApplicationIntent. For more information about SqlClient support for Always On Availability Groups, see SqlClient Support for High Availability, Disaster Recovery.
Gets or sets the name of the application associated with the connection string.
Gets or sets a Boolean value that indicates whether asynchronous processing is allowed by the connection created by using this connection string.
Gets or sets a string that contains the name of the primary data file. This includes the full path name of an attachable database.
Gets the authentication of the connection string.
Gets the column encryption settings for the connection string builder.
Obsolete.Obsolete. Gets or sets a Boolean value that indicates whether the connection is reset when drawn from the connection pool.
[Supported in the .NET Framework 4.5.1 and later versions]
The number of reconnections attempted after identifying that there was an idle connection failure. This must be an integer between 0 and 255. Default is 1. Set to 0 to disable reconnecting on idle connection failures. An ArgumentException will be thrown if set to a value outside of the allowed range.
[Supported in the .NET Framework 4.5.1 and later versions]
Amount of time (in seconds) between each reconnection attempt after identifying that there was an idle connection failure. This must be an integer between 1 and 60. The default is 10 seconds. An ArgumentException will be thrown if set to a value outside of the allowed range.
Gets or sets the length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error.
Gets or sets a value that indicates whether a client/server or in-process connection to SQL Server should be made.
Gets or sets the SQL Server Language record name.
Gets or sets the name or network address of the instance of SQL Server to connect to.
Gets or sets a Boolean value that indicates whether SQL Server uses SSL encryption for all data sent between the client and server if the server has a certificate installed.
Gets or sets a Boolean value that indicates whether the SQL Server connection pooler automatically enlists the connection in the creation thread's current transaction context.
Gets or sets the name or address of the partner server to connect to if the primary server is down.
Gets or sets the name of the database associated with the connection.
Gets or sets a Boolean value that indicates whether User ID and Password are specified in the connection (when false) or whether the current Windows account credentials are used for authentication (when true).
Gets a value that indicates whether the DbConnectionStringBuilder.IsFixedSize.)has a fixed size.(Overrides
Gets or sets the value associated with the specified key. In C#, this property is the indexer.(Overrides DbConnectionStringBuilder.Item(String).)
Gets or sets the minimum time, in seconds, for the connection to live in the connection pool before being destroyed.
Gets or sets the maximum number of connections allowed in the connection pool for this specific connection string.
Gets or sets the minimum number of connections allowed in the connection pool for this specific connection string.
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.
For more information, see Multiple Active Result Sets (MARS).
If your application is connecting to an AlwaysOn availability group (AG) on different subnets, setting MultiSubnetFailover=true provides faster detection of and connection to the (currently) active server. For more information about SqlClient support for Always On Availability Groups, see SqlClient Support for High Availability, Disaster Recovery.
Gets or sets a string that contains the name of the network library used to establish a connection to the SQL Server.
Gets or sets the size in bytes of the network packets used to communicate with an instance of SQL Server.
Gets or sets the password for the SQL Server account.
Gets or sets a Boolean value that indicates if security-sensitive information, such as the password, is not returned as part of the connection if the connection is open or has ever been in an open state.
Gets or sets a Boolean value that indicates whether the connection will be pooled or explicitly opened every time that the connection is requested.
Gets or sets a Boolean value that indicates whether replication is supported using the connection.
Gets or sets a string value that indicates how the connection maintains its association with an enlisted System.Transactions transaction.
Gets or sets a value that indicates whether the channel will be encrypted while bypassing walking the certificate chain to validate trust.
Gets or sets a string value that indicates the type system the application expects.
Gets or sets the user ID to be used when connecting to SQL Server.
Gets or sets 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.
Gets or sets the name of the workstation connecting to SQL Server.
Clears the contents of the DbConnectionStringBuilder.Clear().)instance.(Overrides
Determines whether the DbConnectionStringBuilder.ContainsKey(String).)contains a specific key.(Overrides
Determines whether the specified object is equal to the current object.(Inherited from Object.)
Serves as the default hash function. (Inherited from Object.)
Removes the entry with the specified key from the DbConnectionStringBuilder.Remove(String).)instance.(Overrides
Indicates whether the specified key exists in this DbConnectionStringBuilder.ShouldSerialize(String).)instance.(Overrides
Retrieves a value corresponding to the supplied key from this DbConnectionStringBuilder.TryGetValue(String, Object).).(Overrides
Returns an enumerator that iterates through a collection.(Inherited from DbConnectionStringBuilder.)
Returns a collection of custom attributes for this instance of a component.(Inherited from DbConnectionStringBuilder.)
Returns the class name of this instance of a component.(Inherited from DbConnectionStringBuilder.)
Returns the name of this instance of a component.(Inherited from DbConnectionStringBuilder.)
Returns a type converter for this instance of a component.(Inherited from DbConnectionStringBuilder.)
Returns the default event for this instance of a component.(Inherited from DbConnectionStringBuilder.)
Returns the default property for this instance of a component.(Inherited from DbConnectionStringBuilder.)
Returns an editor of the specified type for this instance of a component.(Inherited from DbConnectionStringBuilder.)
Returns the events for this instance of a component.(Inherited from DbConnectionStringBuilder.)
Returns the events for this instance of a component using the specified attribute array as a filter.(Inherited from DbConnectionStringBuilder.)
Returns the properties for this instance of a component.(Inherited from DbConnectionStringBuilder.)
Returns the properties for this instance of a component using the attribute array as a filter.(Inherited from DbConnectionStringBuilder.)
Returns an object that contains the property described by the specified property descriptor.(Inherited from DbConnectionStringBuilder.)
Overloaded. Enables parallelization of a query.(Defined by ParallelEnumerable.)
The connection string builder lets developers programmatically create syntactically correct connection strings, and parse and rebuild existing connection strings, using properties and methods of the class. The connection string builder provides strongly typed properties corresponding to the known key/value pairs allowed by SQL Server. Developers needing to create connection strings as part of applications can use theclass to build and modify connection strings. The class also makes it easy to manage connection strings stored in an application configuration file.
Theperforms checks for valid key/value pairs. Therefore, you cannot use this class to create invalid connection strings; trying to add invalid pairs will throw an exception. The class maintains a fixed collection of synonyms and can translate from a synonym to the corresponding well-known key name.
For example, when you use the Item property to retrieve a value, you can specify a string that contains any synonym for the key you need. For example, you can specify "Network Address", "addr", or any other acceptable synonym for this key within a connection string when you use any member that requires a string that contains the key name, such as the Item property or the Remove method. See the ConnectionString property for a full list of acceptable synonyms.
The Item property handles tries to insert malicious entries. For example, the following code, using the default Item property (the indexer, in C#) correctly escapes the nested key/value pair:
Dim builder As New System.Data.SqlClient.SqlConnectionStringBuilder builder("Data Source") = "(local)" builder("Integrated Security") = True builder("Initial Catalog") = "AdventureWorks;NewValue=Bad" Console.WriteLine(builder.ConnectionString)
System.Data.SqlClient.SqlConnectionStringBuilder builder = new System.Data.SqlClient.SqlConnectionStringBuilder(); builder["Data Source"] = "(local)"; builder["integrated Security"] = true; builder["Initial Catalog"] = "AdventureWorks;NewValue=Bad"; Console.WriteLine(builder.ConnectionString);
The result is the following connection string that handles the invalid value in a safe manner:
Source=(local);Initial Catalog="AdventureWorks;NewValue=Bad"; Integrated Security=True
Legacy Code Example
The following console application builds connection strings for a SQL Server database. The code uses a ConnectionString property of the instance to the constructor of the connection class. The example also parses an existing connection string and demonstrates various ways of manipulating the connection string's contents.class to create the connection string, and then passes the
This example includes a password to demonstrate howworks with connection strings. In your applications, we recommend that you use Windows Authentication. If you must use a password, do not include a hard-coded password in your application.
Available since 2.0
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.