SqlConnectionStringBuilder.DataSource 属性

定义

命名空间:

Microsoft.Data.SqlClient

程序集:

Microsoft.Data.SqlClient.dll

包:

Microsoft.Data.SqlClient v5.2.0

获取或设置要连接到的 SQL Server 实例的名称或网络地址。

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

public string DataSource { get; set; }

member this.DataSource : string with get, set

Public Property DataSource As String

属性值

String

为 DataSource 属性的值，或者，如果未提供任何值，则为 String.Empty。

例外

ArgumentNullException

若要将值设置为 null，请使用 Value。

示例

以下示例演示 SqlConnectionStringBuilder 类将“Data Source”连接字符串键的同义词转换为已知键：

using Microsoft.Data.SqlClient;

class Program
{
    static void Main()
    {
        SqlConnectionStringBuilder builder = new SqlConnectionStringBuilder(
            "Network Address=(local);Integrated Security=SSPI;" +
            "Initial Catalog=AdventureWorks");

        // Display the connection string, which should now 
        // contain the "Data Source" key, as opposed to the 
        // supplied "Network Address".
        Console.WriteLine(builder.ConnectionString);

        // Retrieve the DataSource property.
        Console.WriteLine("DataSource = " + builder.DataSource);

        Console.WriteLine("Press any key to continue.");
        Console.ReadLine();
    }
}

注解

此属性与连接字符串内的“Data Source”、“server”、“address”、“addr”和“network address”键相对应。 无论在提供的连接字符串中提供了这些值中的哪一个值，由 SqlConnectionStringBuilder 创建的连接字符串都将使用众所周知的“数据源”密钥。

可以在服务器名称之后指定端口号： server=tcp:servername, portnumber。

指定本地实例时，始终使用 (本地) 。 若要强制协议，请添加以下前缀之一：np:(local), tcp:(local), lpc:(local)。

还可以按如下所示连接到 LocalDB 数据库： server=(localdb)\\myInstance。 有关 LocalDB 的详细信息，请参阅 SqlClient 支持 LocalDB。 数据源 必须使用 TCP 格式或命名管道格式。 TCP 格式如下所示：

• tcp：<host name>\<instance name>
• tcp：<主机名>，<TCP/IP 端口号>

TCP 格式必须以前缀“tcp：”开头，后跟数据库实例，由主机名和实例名称指定。 连接到 Azure SQL 数据库时，此格式不适用。 如果未指定任何协议，则会自动选择 TCP 以连接到 Azure SQL 数据库。

必须通过以下方式之一指定主机名：

• NetBIOSName
• IPv4Address
• IPv6Address

实例名称用于解析为托管数据库实例的特定 TCP/IP 端口号。 或者，还允许直接指定 TCP/IP 端口号。 如果实例名称和端口号都不存在，则使用默认数据库实例。

命名管道格式如下所示：

• np：\\<host name>\pipe\pipe name<>

命名管道格式必须以前缀“np：”开头，后跟命名管道名称。

必须通过以下方式之一指定主机名：

• NetBIOSName
• IPv4Address
• IPv6Address

管道名称用于标识 .NET 应用程序将连接到的数据库实例。

如果指定 了网络 键的值，则不应指定前缀“tcp：”和“np：”。 注意： 可以通过在连接字符串中的服务器名称前加上 tcp： 前缀，或使用 localhost 来强制使用 TCP 而不是共享内存。