SqlConnectionStringBuilder 类

定义

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

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

[System.ComponentModel.TypeConverter(typeof(System.Data.SqlClient.SqlConnectionStringBuilder+SqlConnectionStringBuilderConverter))]
public sealed class SqlConnectionStringBuilder : System.Data.Common.DbConnectionStringBuilder

type SqlConnectionStringBuilder = class
    inherit DbConnectionStringBuilder

[<System.ComponentModel.TypeConverter(typeof(System.Data.SqlClient.SqlConnectionStringBuilder+SqlConnectionStringBuilderConverter))>]
type SqlConnectionStringBuilder = class
    inherit DbConnectionStringBuilder

Public NotInheritable Class SqlConnectionStringBuilder
Inherits DbConnectionStringBuilder

继承

Object

DbConnectionStringBuilder

SqlConnectionStringBuilder

属性

TypeConverterAttribute

示例

以下控制台应用程序为 SQL Server 数据库生成连接字符串。 该代码使用 SqlConnectionStringBuilder 类创建连接字符串。 然后，该示例分析连接字符串，并演示了操作其内容的各种方法。

// 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

注解

使用连接字符串生成器，开发人员可以使用类的属性和方法以编程方式创建语法正确的连接字符串，并分析和重新生成现有连接字符串。 连接字符串生成器提供与 SQL Server 允许的已知键/值对对应的强类型属性。 如果需要在应用中创建连接字符串，可以使用 SqlConnectionStringBuilder 类生成和修改连接字符串。 该类还可以轻松地管理存储在应用程序配置文件中的连接字符串。

SqlConnectionStringBuilder 对执行有效键/值对检查。 因此，不能使用此类创建无效的连接字符串;尝试添加无效对将引发异常。 该类维护同义词的固定集合，并且可以从同义词转换为相应的已知键名称。

例如，使用 Item 属性检索值时，可以指定包含所需密钥的任何同义词的字符串。 例如，当使用需要包含密钥名称的字符串的任何成员（如 Item[String] 属性或 Remove 方法）时，可以在连接字符串中指定“网络地址”、“addr”或此密钥的任何其他可接受同义词。 有关可接受同义词的完整列表，请参阅 ConnectionString 属性。

Item[String] 属性处理插入恶意条目的尝试。 例如，以下代码使用默认 Item 属性（C# 中的索引器）正确地转义嵌套键/值对：

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);

结果是以下连接字符串，以安全方式处理无效值：

Source=(local);Initial Catalog="AdventureWorks;NewValue=Bad";
Integrated Security=True

构造函数

属性

方法

显式接口实现

扩展方法

适用于

另请参阅

• 连接字符串 （ADO.NET）
• ADO.NET 概述