SqlConnectionStringBuilder Class

Definition

Namespace:

System.Data.SqlClient

Assembly:

System.Data.SqlClient.dll

Package:

System.Data.SqlClient v4.9.0

Source:

System.Data.SqlClient.notsupported.cs

Caution

Use the Microsoft.Data.SqlClient package instead.

Provides a simple way to create and manage the contents of connection strings used by the SqlConnection class.

public ref class SqlConnectionStringBuilder sealed : System::Data::Common::DbConnectionStringBuilder

[System.Obsolete("Use the Microsoft.Data.SqlClient package instead.")]
public sealed class SqlConnectionStringBuilder : System.Data.Common.DbConnectionStringBuilder

[<System.Obsolete("Use the Microsoft.Data.SqlClient package instead.")>]
type SqlConnectionStringBuilder = class
    inherit DbConnectionStringBuilder

Public NotInheritable Class SqlConnectionStringBuilder
Inherits DbConnectionStringBuilder

Inheritance

Object

DbConnectionStringBuilder

SqlConnectionStringBuilder

Attributes

ObsoleteAttribute

Examples

The following console application builds connection strings for a SQL Server database. The code uses the SqlConnectionStringBuilder class to create the connection string. The example then parses the connection string and demonstrates various ways of manipulating the its contents.

// Create a new SqlConnectionStringBuilder and
// initialize it with a few name/value pairs.
SqlConnectionStringBuilder builder = new(
    "Server=(local);Integrated Security=true;" +
    "Initial Catalog=AdventureWorks"
    );

// The input connection string used the
// Server key, but the new connection string uses
// the well-known Data Source key instead.
Console.WriteLine($"Original connection string: '{builder.ConnectionString}'");

// Now that the connection string has been parsed,
// you can work with individual items.
Console.WriteLine($"Initial catalog: '{builder.InitialCatalog}'");
builder.InitialCatalog = "Northwind";
builder.AsynchronousProcessing = true;

// You can refer to connection keys using strings,
// as well. When you use this technique (the default
// Item property in Visual Basic, or the indexer in C#),
// you can specify any synonym for the connection string key name.
builder["Server"] = ".";
builder["Connect Timeout"] = 1000;
builder["Trusted_Connection"] = true;
Console.WriteLine($"Modified connection string: '{builder.ConnectionString}'");

Imports System.Data.SqlClient

Module Module1
    Sub Main()
        ' Create a new SqlConnectionStringBuilder and
        ' initialize it with a few name/value pairs:
        Dim builder As New SqlConnectionStringBuilder(
            "Server=(local);Integrated Security=true;" &
            "Initial Catalog=AdventureWorks"
            )

        ' The input connection string used the 
        ' Server key, but the new connection string uses
        ' the well-known Data Source key instead.
        Console.WriteLine("Original connection string: " + builder.ConnectionString)

        ' Now that the connection string has been parsed,
        ' you can work with individual items.
        Console.WriteLine("Initial catalog: " + builder.InitialCatalog)
        builder.InitialCatalog = "Northwind"
        builder.AsynchronousProcessing = True

        ' You can refer to connection keys using strings, 
        ' as well. When you use this technique (the default
        ' Item property in Visual Basic, or the indexer in C#)
        ' you can specify any synonym for the connection string key
        ' name.
        builder("Server") = "."
        builder("Connect Timeout") = 1000

        ' The Item property is the default for the class, 
        ' and setting the Item property adds the value to the 
        ' dictionary, if necessary. 
        builder.Item("Trusted_Connection") = True
        Console.WriteLine("Modified connection string: " + builder.ConnectionString)
    End Sub
End Module

Remarks

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. If you need to create connection strings as part of your app, you can use the SqlConnectionStringBuilder class to build and modify connection strings. The class also makes it easy to manage connection strings stored in an application configuration file.

SqlConnectionStringBuilder performs 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[String] property or the Remove method. See the ConnectionString property for a full list of acceptable synonyms.

The Item[String] property handles attempts 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

Constructors

SqlConnectionStringBuilder()	Initializes a new instance of the SqlConnectionStringBuilder class.
SqlConnectionStringBuilder(String)	Initializes a new instance of the SqlConnectionStringBuilder class. The provided connection string provides the data for the instance's internal connection information.

Properties

ApplicationIntent	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.
ApplicationName	Gets or sets the name of the application associated with the connection string.
AttachDBFilename	Gets or sets a string that contains the name of the primary data file. This includes the full path name of an attachable database.
BrowsableConnectionString	Gets or sets a value that indicates whether the ConnectionString property is visible in Visual Studio designers. (Inherited from DbConnectionStringBuilder)
ConnectionString	Gets or sets the connection string associated with the DbConnectionStringBuilder. (Inherited from DbConnectionStringBuilder)
ConnectRetryCount	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.
ConnectRetryInterval	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.
ConnectTimeout	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.
Count	Gets the current number of keys that are contained within the ConnectionString property. (Inherited from DbConnectionStringBuilder)
CurrentLanguage	Gets or sets the SQL Server Language record name.
DataSource	Gets or sets the name or network address of the instance of SQL Server to connect to.
Encrypt	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.
Enlist	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.
FailoverPartner	Gets or sets the name or address of the partner server to connect to if the primary server is down.
InitialCatalog	Gets or sets the name of the database associated with the connection.
IntegratedSecurity	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).
IsFixedSize	Gets a value that indicates whether the DbConnectionStringBuilder has a fixed size. (Inherited from DbConnectionStringBuilder)
IsReadOnly	Gets a value that indicates whether the DbConnectionStringBuilder is read-only. (Inherited from DbConnectionStringBuilder)
Item[String]	Gets or sets the value associated with the specified key. In C#, this property is the indexer.
Keys	Gets an ICollection that contains the keys in the SqlConnectionStringBuilder.
LoadBalanceTimeout	Gets or sets the minimum time, in seconds, for the connection to live in the connection pool before being destroyed.
MaxPoolSize	Gets or sets the maximum number of connections allowed in the connection pool for this specific connection string.
MinPoolSize	Gets or sets the minimum number of connections allowed in the connection pool for this specific connection string.
MultipleActiveResultSets	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).
MultiSubnetFailover	If your application is connecting to an Always On availability group (AG) or Always On Failover Cluster Instance (FCI) on different subnets, setting MultiSubnetFailover=true provides faster detection of and connection to the (currently) active server. For more information about SqlClient support for the Always On features, see SqlClient Support for High Availability, Disaster Recovery.
PacketSize	Gets or sets the size in bytes of the network packets used to communicate with an instance of SQL Server.
Password	Gets or sets the password for the SQL Server account.
PersistSecurityInfo	Gets or sets a value indicating if security-sensitive information, such as the password or access token, should be returned as part of the connection string on a connection created with this SqlConnectionStringBuilder after that connection has ever been in an open state.
PoolBlockingPeriod	The blocking period behavior for a connection pool.
Pooling	Gets or sets a Boolean value that indicates whether the connection will be pooled or explicitly opened every time that the connection is requested.
Replication	Gets or sets a Boolean value that indicates whether replication is supported using the connection.
TransactionBinding	Gets or sets a string value that indicates how the connection maintains its association with an enlisted System.Transactions transaction.
TrustServerCertificate	Gets or sets a value that indicates whether the channel will be encrypted while bypassing walking the certificate chain to validate trust.
TypeSystemVersion	Gets or sets a string value that indicates the type system the application expects.
UserID	Gets or sets the user ID to be used when connecting to SQL Server.
UserInstance	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.
Values	Gets an ICollection that contains the values in the SqlConnectionStringBuilder.
WorkstationID	Gets or sets the name of the workstation connecting to SQL Server.

Methods

Add(String, Object)	Adds an entry with the specified key and value into the DbConnectionStringBuilder. (Inherited from DbConnectionStringBuilder)
Clear()	Clears the contents of the SqlConnectionStringBuilder instance.
ClearPropertyDescriptors()	Clears the collection of PropertyDescriptor objects on the associated DbConnectionStringBuilder. (Inherited from DbConnectionStringBuilder)
ContainsKey(String)	Determines whether the SqlConnectionStringBuilder contains a specific key.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
EquivalentTo(DbConnectionStringBuilder)	Compares the connection information in this DbConnectionStringBuilder object with the connection information in the supplied object. (Inherited from DbConnectionStringBuilder)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetProperties(Hashtable)	Fills a supplied Hashtable with information about all the properties of this DbConnectionStringBuilder. (Inherited from DbConnectionStringBuilder)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
Remove(String)	Removes the entry with the specified key from the SqlConnectionStringBuilder instance.
ShouldSerialize(String)	Indicates whether the specified key exists in this SqlConnectionStringBuilder instance.
ToString()	Returns the connection string associated with this DbConnectionStringBuilder. (Inherited from DbConnectionStringBuilder)
TryGetValue(String, Object)	Retrieves a value corresponding to the supplied key from this SqlConnectionStringBuilder.

Extension Methods

See also

• Connection Strings (ADO.NET)
• ADO.NET Overview