SqlConnection.ConnectionString プロパティ

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

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

public override string ConnectionString { get; set; }

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

member this.ConnectionString : string with get, set

Public Overrides Property ConnectionString As String

プロパティ値

ソース データベース名と、初期接続を確立するために必要なその他のパラメーターを含む接続文字列。 既定値は空の文字列です。

属性

SettingsBindableAttribute

例外

例

次の例では、接続を開く前に SqlConnection を作成し、 ConnectionString プロパティを設定します。

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;";
    }
}

次の例では、接続を開く前に SqlConnection を作成し、 ConnectionString プロパティを設定します。

using System;
using System.Data;
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;";
    }
}

注釈

ConnectionStringは OLE DB 接続文字列に似ていますが、同じではありません。 OLE DB または ADO とは異なり、返される接続文字列は、ユーザー セットの ConnectionStringと同じです。[セキュリティ情報の保持] 値が false (既定値) に設定されている場合は、セキュリティ情報を差し引きます。 [セキュリティ情報の保持] を [ true] に設定しない限り、.NET Framework Data Provider for SQL Server は接続文字列にパスワードを保持または返しません。
ConnectionString プロパティを使用して、データベースに接続できます。 次の例は、一般的な接続文字列を示しています。

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

新しい SqlConnectionStringBuilder を使用して、実行時に有効な接続文字列を作成します。 詳細については、「接続文字列ビルダー」をご覧ください。

ConnectionString プロパティは、接続が閉じている場合にのみ設定できます。 接続文字列の値の多くは、対応する読み取り専用プロパティを持ちます。 接続文字列が設定されると、エラーが検出された場合を除き、これらのプロパティが更新されます。 この場合、どのプロパティも更新されません。 SqlConnection プロパティは、 ConnectionStringに含まれている設定のみを返します。

ローカル コンピューターに接続するには、サーバーの "(local)" を指定します。 サーバー名が指定されていない場合、ローカル コンピューター上の既定のインスタンスへの接続が試行されます。

閉じた接続で ConnectionString をリセットすると、パスワードを含むすべての接続文字列値 (および関連プロパティ) がリセットされます。 たとえば、"Database= AdventureWorks" を含む接続文字列を設定し、接続文字列を "Data Source=myserver" にリセットするとします。Integrated Security=true"、 Database プロパティが "AdventureWorks" に設定されなくなりました。

接続文字列は、設定された直後に解析されます。 構文の解析時にエラーが見つかった場合は、 ArgumentExceptionなどのランタイム例外が生成されます。 その他のエラーは、接続を開こうとした場合にのみ見つかります。

接続文字列の基本形式には、セミコロンで区切られた一連のキーワードと値のペアが含まれます。 等号 (=) は、各キーワードとその値を接続します。 セミコロン、一重引用符、または二重引用符を含む値を含めるには、値を二重引用符で囲む必要があります。 値にセミコロンと二重引用符の両方が含まれている場合、値は単一引用符で囲むことができます。 単一引用符は、値が二重引用符で始まる場合にも便利です。 逆に、値が単一引用符で始まる場合は、二重引用符を使用できます。 値に一重引用符と二重引用符の両方の文字が含まれている場合、値を囲むために使用される引用符文字は、値内で発生するたびに 2 倍にする必要があります。

文字列値に前後のスペースを含めるには、値を単一引用符または二重引用符で囲む必要があります。 引用符で囲まれている場合でも、整数、ブール値、または列挙値の前後のスペースは無視されます。 ただし、文字列リテラルキーワードまたは値内のスペースは保持されます。 引用符文字が値の最初または最後の文字でない限り、単一引用符または二重引用符は、区切り記号を使用せずに接続文字列内で使用できます (たとえば、Data Source= my'Server または Data Source= my"Server)。

キーワードでは大文字と小文字は区別されません。

次の表に、 ConnectionString内のキーワード値の有効な名前を示します。

次の一覧には、 ConnectionString内の接続プール値の有効な名前が含まれています。 詳しくは、「SQL Server の接続プール (ADO.NET)」をご覧ください。

• 接続の有効期間 (または負荷分散タイムアウト)

• 参加

• 最大プール サイズ

• 最小プール サイズ

• プーリング

ブール値を必要とするキーワードまたは接続プール値を設定する場合は、'true' ではなく 'yes' を使用し、'false' の代わりに 'no' を使用できます。 整数値は文字列として表されます。