SqlConnection.ConnectionString プロパティ

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

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

public override string ConnectionString { get; set; }

[System.Data.DataSysDescription("SqlConnection_ConnectionString")]
public string ConnectionString { get; set; }

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

member this.ConnectionString : string with get, set

[<System.Data.DataSysDescription("SqlConnection_ConnectionString")>]
member this.ConnectionString : string with get, set

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

Public Overrides Property ConnectionString As String

Public Property ConnectionString As String

プロパティ値

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

実装

属性

DataSysDescriptionAttribute SettingsBindableAttribute

例外

例

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

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

Private Sub OpenSqlConnection()
    Dim connectionString As String = GetConnectionString()

    Using connection As New SqlConnection()

        connection.ConnectionString = connectionString

        connection.Open()

        Console.WriteLine("State: {0}", connection.State)
        Console.WriteLine("ConnectionString: {0}", _
            connection.ConnectionString)
    End Using
End Sub

Private Function GetConnectionString() As String
    ' To avoid storing the connection string in your code,  
    ' you can retrieve it from a configuration file.
    Return "Data Source=MSSQL1;Database=AdventureWorks;" _
      & "Integrated Security=true;"
End Function

注釈

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

プロパティを ConnectionString 使用してデータベースに接続できます。 次の例は、一般的な接続文字列を示しています。

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

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

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

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

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

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

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

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

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

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

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

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

• Enlist

• Max Pool Size

• Min Pool Size

• Pooling

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

適用対象

こちらもご覧ください

• ADO.NET のマネージド プロバイダーと DataSet デベロッパー センター
• ADO.NET での接続文字列
• SQL Server の接続プール (ADO.NET)
• ADO.NET でのデータ ソースへの接続
• ADO.NET の概要