DbConnectionStringBuilder クラス
アセンブリ: System.Data (system.data.dll 内)

Public Class DbConnectionStringBuilder Implements IDictionary, ICollection, IEnumerable, ICustomTypeDescriptor
public class DbConnectionStringBuilder : IDictionary, ICollection, IEnumerable, ICustomTypeDescriptor
public ref class DbConnectionStringBuilder : IDictionary, ICollection, IEnumerable, ICustomTypeDescriptor

DbConnectionStringBuilder クラスにより、厳密に型指定された接続文字列ビルダ (SqlConnectionStringBuilder や OleDbConnectionStringBuilder など) の派生元となる基本クラスが得られます。この接続文字列ビルダを使用して、正確な構文の接続文字列をプログラムから作成したり、既存の接続文字列を解析、再構築したりできます。
DbConnectionStringBuilder はデータベースを選ばない方法で定義されていました。System.Data.Common 名前空間が追加されたため、任意のデータベースに対して有効な接続文字列を構築するためにプログラムで使用できる基本クラスが必要です。つまり、DbConnectionStringBuilder クラスによってユーザーは任意のキー/値ペアを割り当て、生成された接続文字列を厳密に型指定されたプロバイダに渡すことができます。.NET Framework の一部となっているすべてのデータ プロバイダが、DbConnectionStringBuilder から継承された厳密に型指定されたクラスを提供します。そのクラスとは、SqlConnectionStringBuilder、OracleConnectionStringBuilder、OdbcConnectionStringBuilder、OleDbConnectionStringBuilder です。
任意のプロバイダの接続文字列を構築、割り当て、編集できます。特定のキー/値ペアをサポートするプロバイダの場合、接続文字列ビルダによってそのペアに対応する厳密に型指定されたプロパティが得られます。未知の値をサポートする機能が要求されるプロバイダをサポートするために、任意のキー/値ペアを指定することもできます。
DbConnectionStringBuilder クラスは、ICustomTypeDescriptor インターフェイスを実装します。つまり、このクラスはデザイン時に Visual Studio デザイナと組み合わせて使用できます。デザイナを使用して、Visual Studio で厳密に型指定された DataSet と厳密に型指定された接続を構築すると、厳密に型指定された接続文字列ビルダ クラスでは、その型に関連付けられたプロパティが表示され、さらに既知のキーに共通の値を割り当てられるコンバータが得られます。
接続文字列をアプリケーション内で生成する必要がある場合、DbConnectionStringBuilder クラス、またはその厳密に型指定された派生クラスを使用して、接続文字列を構築したり修正したりできます。また、DbConnectionStringBuilder クラスを利用することで、アプリケーションの構成ファイルに格納される接続文字列の管理が容易になります。
厳密に型指定された接続文字列ビルダ クラス、または DbConnectionStringBuilder クラスを使用して、接続文字列を作成できます。DbConnectionStringBuilder では、キー/値ペアが有効であるかどうかのチェックは実行されません。したがって、このクラスを使用すると無効な接続文字列が作成される可能性があります。SqlConnectionStringBuilder では、SQL Server でサポートされるキー/値ペアのみがサポートされます。無効なペアを追加しようとすると、例外がスローされます。
悪意のあるエントリを挿入しようとする操作は、Add メソッドと Item プロパティによって処理されます。たとえば、入れ子になったキー/値ペアは次のコードによって適切にエスケープされます。
Dim builder As New System.Data.Common.DbConnectionStringBuilder builder("Data Source") = "(local)" builder("integrated sSecurity") = True builder("Initial Catalog") = "AdventureWorks;NewValue=Bad"
[C#]

Microsoft Jet データベースと Microsoft SQL Server 2005 データベース用に、2 つの接続文字列を構築するコンソール アプリケーションを次に示します。どちらの接続文字列の場合も、このコードでは汎用の DbConnectionStringBuilder クラスを使用して接続文字列を作成し、DbConnectionStringBuilder インスタンスの ConnectionString プロパティを厳密に型指定された接続クラスのコンストラクタに渡しています。この動作は必須ではありません。コードでは、厳密に型指定された接続文字列ビルダのインスタンスを個別に作成することもできます。さらにこの例では、既存の接続文字列を解析し、接続文字列の内容に対して各種の操作を行う例が示されています。
Sub Main() Dim builder As New DbConnectionStringBuilder() builder.ConnectionString = "Data Source=c:\MyData\MyDb.mdb" builder.Add("Provider", "Microsoft.Jet.Oledb.4.0") builder.Add("Jet OLEDB:Database Password", "*******") builder.Add("Jet OLEDB:System Database", _ "c:\MyData\Workgroup.mdb") ' Set up row-level locking. builder.Add("Jet OLEDB:Database Locking Mode", 1) ' Note that the DbConnectionStringBuilder class ' is database agnostic, and it's possible to ' build any type of connection string using ' this class. ' Notice that the ConnectionString property may have been ' formatted by the DbConnectionStringBuilder class. Dim oledbConnect As New _ OleDbConnection(builder.ConnectionString) Console.WriteLine(oledbConnect.ConnectionString) ' Use the same DbConnectionStringBuilder to create ' a SqlConnection object. builder.Clear() builder.Add("integrated security", True) builder.Add("Initial Catalog", "AdventureWorks") builder.Add("Data Source", "(local)") Dim sqlConnect As New SqlConnection(builder.ConnectionString) Console.WriteLine(sqlConnect.ConnectionString) ' Pass the DbConnectionStringBuilder an existing ' connection string, and you can retrieve and ' modify any of the elements. builder.ConnectionString = _ "server=(local);user id=*******;" & _ "password=*******;initial catalog=AdventureWorks" builder.Item("Server") = "." builder.Remove("User ID") ' Note that calling Remove on a nonexistent item doesn't ' throw an exception. builder.Remove("BadItem") ' The Item property is the default for the class, ' and setting the Item property adds the value if ' necessary. builder("Integrated Security") = True builder.Remove("password") builder.Item("User ID") = "Hello" Console.WriteLine(builder.ConnectionString) Console.WriteLine("Press Enter to finish.") Console.ReadLine() End Sub
static void Main() { DbConnectionStringBuilder builder = new DbConnectionStringBuilder(); builder.ConnectionString = @"Data Source=c:\MyData\MyDb.mdb"; builder.Add("Provider", "Microsoft.Jet.Oledb.4.0"); builder.Add("Jet OLEDB:Database Password", "*******"); builder.Add("Jet OLEDB:System Database", @"c:\MyData\Workgroup.mdb"); // Set up row-level locking. builder.Add("Jet OLEDB:Database Locking Mode", 1); // The DbConnectionStringBuilder class // is database agnostic, so it's possible to // build any type of connection string using // this class. // The ConnectionString property may have been // formatted by the DbConnectionStringBuilder class. OleDbConnection oledbConnect = new OleDbConnection(builder.ConnectionString); Console.WriteLine(oledbConnect.ConnectionString); // Use the same DbConnectionStringBuilder to create // a SqlConnection object. builder.Clear(); builder.Add("integrated security", true); builder.Add("Initial Catalog", "AdventureWorks"); builder.Add("Data Source", "(local)"); SqlConnection sqlConnect = new SqlConnection(builder.ConnectionString); Console.WriteLine(sqlConnect.ConnectionString); // Pass the DbConnectionStringBuilder an existing // connection string, and you can retrieve and // modify any of the elements. builder.ConnectionString = "server=(local);user id=*******;" + "password=*******;initial catalog=AdventureWorks"; builder["Server"] = "."; builder.Remove("User ID"); // Note that calling Remove on a nonexistent item doesn't // throw an exception. builder.Remove("BadItem"); // Setting the indexer adds the value if // necessary. builder["Integrated Security"] = true; builder.Remove("password"); builder["User ID"] = "Hello"; Console.WriteLine(builder.ConnectionString); Console.WriteLine("Press Enter to finish."); Console.ReadLine(); }

System.Data.Common.DbConnectionStringBuilder
System.Data.Odbc.OdbcConnectionStringBuilder
System.Data.OleDb.OleDbConnectionStringBuilder
System.Data.OracleClient.OracleConnectionStringBuilder
System.Data.SqlClient.SqlConnectionStringBuilder


Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。


DbConnectionStringBuilder コンストラクタ ()
アセンブリ: System.Data (system.data.dll 内)


Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。


DbConnectionStringBuilder コンストラクタ

名前 | 説明 |
---|---|
DbConnectionStringBuilder () | DbConnectionStringBuilder クラスの新しいインスタンスを初期化します。 |
DbConnectionStringBuilder (Boolean) | DbConnectionStringBuilder クラスの新しいインスタンスを初期化します。必要に応じて、ODBC の規則を使用して値を区切ることができます。 |

DbConnectionStringBuilder コンストラクタ (Boolean)
アセンブリ: System.Data (system.data.dll 内)


useOdbcRules が true の場合、この DbConnectionStringBuilder では ODBC の規則を使用して値を区切ります (値を中かっこ ({}) で囲みます)。useOdbcRules が false の場合、この DbConnectionStringBuilder では引用符文字 ("") を使用して値を区切ります。

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。


DbConnectionStringBuilder プロパティ

名前 | 説明 | |
---|---|---|
![]() | BrowsableConnectionString | ConnectionString プロパティが Visual Studio デザイナに表示できるかどうかを指定する値を取得または設定します。 |
![]() | ConnectionString | DbConnectionStringBuilder に関連付けられる接続文字列を取得または設定します。 |
![]() | Count | ConnectionString プロパティに格納されている、現在のキー数を取得します。 |
![]() | IsFixedSize | DbConnectionStringBuilder が固定サイズかどうかを示す値を取得します。 |
![]() | IsReadOnly | DbConnectionStringBuilder が読み取り専用かどうかを示す値を取得します。 |
![]() | Item | 指定したキーに関連付けられている値を取得または設定します。 |
![]() | Keys | DbConnectionStringBuilder 内のキーを格納している ICollection を取得します。 |
![]() | Values | DbConnectionStringBuilder 内の値を格納している ICollection を取得します。 |

名前 | 説明 | |
---|---|---|
![]() | System.Collections.ICollection.IsSynchronized | このメンバの説明については、System.Collections.ICollection.IsSynchronized のトピックを参照してください。 |
![]() | System.Collections.ICollection.SyncRoot | このメンバの説明については、System.Collections.ICollection.SyncRoot のトピックを参照してください。 |
![]() | System.Collections.IDictionary.Item | このメンバの説明については、System.Collections.IDictionary.Item(System.Object) のトピックを参照してください。 |

DbConnectionStringBuilder メソッド

名前 | 説明 | |
---|---|---|
![]() | Add | 指定したキーおよび値を持つエントリを DbConnectionStringBuilder に追加します。 |
![]() | AppendKeyValuePair | オーバーロードされます。 効率的かつ安全に、既存の StringBuilder オブジェクトにキーと値を追加できます。 |
![]() | Clear | DbConnectionStringBuilder インスタンスの内容を消去します。 |
![]() | ContainsKey | DbConnectionStringBuilder に特定のキーが格納されているかどうかを判断します。 |
![]() | Equals | オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。) |
![]() | EquivalentTo | この DbConnectionStringBuilder オブジェクト内の接続情報と、指定したオブジェクト内の接続情報を比較します。 |
![]() | GetHashCode | 特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。) |
![]() | GetType | 現在のインスタンスの Type を取得します。 ( Object から継承されます。) |
![]() | ReferenceEquals | 指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。) |
![]() | Remove | 指定したキーを持つエントリを DbConnectionStringBuilder インスタンスから削除します。 |
![]() | ShouldSerialize | 指定されたキーが、この DbConnectionStringBuilder インスタンスに存在するかどうかを示します。 |
![]() | ToString | オーバーライドされます。 この DbConnectionStringBuilder に関連付けられている接続文字列を返します。 |
![]() | TryGetValue | 指定されたキーに対応する値を DbConnectionStringBuilder から取得します。 |

名前 | 説明 | |
---|---|---|
![]() | ClearPropertyDescriptors | 関連付けられている DbConnectionStringBuilder で、PropertyDescriptor オブジェクトのコレクションを削除します。 |
![]() | Finalize | Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。) |
![]() | GetProperties | 指定した HashTable に、この DbConnectionStringBuilder のすべてのプロパティに関する情報を格納します。 |
![]() | MemberwiseClone | 現在の Object の簡易コピーを作成します。 ( Object から継承されます。) |

名前 | 説明 | |
---|---|---|
![]() | System.Collections.ICollection.CopyTo | このメンバの説明については、ICollection.CopyTo のトピックを参照してください。 |
![]() | System.Collections.IDictionary.Add | このメンバの説明については、IDictionary.Add のトピックを参照してください。 |
![]() | System.Collections.IDictionary.Contains | このメンバの説明については、IDictionary.Contains のトピックを参照してください。 |
![]() | System.Collections.IDictionary.GetEnumerator | このメンバの説明については、IDictionary.GetEnumerator のトピックを参照してください。 |
![]() | System.Collections.IDictionary.Remove | このメンバの説明については、IDictionary.Remove のトピックを参照してください。 |
![]() | System.Collections.IEnumerable.GetEnumerator | このメンバの説明については、IEnumerable.GetEnumerator のトピックを参照してください。 |
![]() | System.ComponentModel.ICustomTypeDescriptor.GetAttributes | このメンバの説明については、ICustomTypeDescriptor.GetAttributes のトピックを参照してください。 |
![]() | System.ComponentModel.ICustomTypeDescriptor.GetClassName | このメンバの説明については、ICustomTypeDescriptor.GetClassName のトピックを参照してください。 |
![]() | System.ComponentModel.ICustomTypeDescriptor.GetComponentName | このメンバの説明については、ICustomTypeDescriptor.GetComponentName のトピックを参照してください。 |
![]() | System.ComponentModel.ICustomTypeDescriptor.GetConverter | このメンバの説明については、ICustomTypeDescriptor.GetConverter のトピックを参照してください。 |
![]() | System.ComponentModel.ICustomTypeDescriptor.GetDefaultEvent | このメンバの説明については、ICustomTypeDescriptor.GetDefaultEvent のトピックを参照してください。 |
![]() | System.ComponentModel.ICustomTypeDescriptor.GetDefaultProperty | このメンバの説明については、ICustomTypeDescriptor.GetDefaultProperty のトピックを参照してください。 |
![]() | System.ComponentModel.ICustomTypeDescriptor.GetEditor | このメンバの説明については、ICustomTypeDescriptor.GetEditor のトピックを参照してください。 |
![]() | System.ComponentModel.ICustomTypeDescriptor.GetEvents | オーバーロードされます。 |
![]() | System.ComponentModel.ICustomTypeDescriptor.GetProperties | オーバーロードされます。 |
![]() | System.ComponentModel.ICustomTypeDescriptor.GetPropertyOwner | このメンバの説明については、ICustomTypeDescriptor.GetPropertyOwner のトピックを参照してください。 |

DbConnectionStringBuilder メンバ
厳密に型指定された接続文字列ビルダの基本クラスを提供します。
DbConnectionStringBuilder データ型で公開されるメンバを以下の表に示します。


名前 | 説明 | |
---|---|---|
![]() | BrowsableConnectionString | ConnectionString プロパティが Visual Studio デザイナに表示できるかどうかを指定する値を取得または設定します。 |
![]() | ConnectionString | DbConnectionStringBuilder に関連付けられる接続文字列を取得または設定します。 |
![]() | Count | ConnectionString プロパティに格納されている、現在のキー数を取得します。 |
![]() | IsFixedSize | DbConnectionStringBuilder が固定サイズかどうかを示す値を取得します。 |
![]() | IsReadOnly | DbConnectionStringBuilder が読み取り専用かどうかを示す値を取得します。 |
![]() | Item | 指定したキーに関連付けられている値を取得または設定します。 |
![]() | Keys | DbConnectionStringBuilder 内のキーを格納している ICollection を取得します。 |
![]() | Values | DbConnectionStringBuilder 内の値を格納している ICollection を取得します。 |

名前 | 説明 | |
---|---|---|
![]() | Add | 指定したキーおよび値を持つエントリを DbConnectionStringBuilder に追加します。 |
![]() | AppendKeyValuePair | オーバーロードされます。 効率的かつ安全に、既存の StringBuilder オブジェクトにキーと値を追加できます。 |
![]() | Clear | DbConnectionStringBuilder インスタンスの内容を消去します。 |
![]() | ContainsKey | DbConnectionStringBuilder に特定のキーが格納されているかどうかを判断します。 |
![]() | Equals | オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。) |
![]() | EquivalentTo | この DbConnectionStringBuilder オブジェクト内の接続情報と、指定したオブジェクト内の接続情報を比較します。 |
![]() | GetHashCode | 特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。) |
![]() | GetType | 現在のインスタンスの Type を取得します。 (Object から継承されます。) |
![]() | ReferenceEquals | 指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。) |
![]() | Remove | 指定したキーを持つエントリを DbConnectionStringBuilder インスタンスから削除します。 |
![]() | ShouldSerialize | 指定されたキーが、この DbConnectionStringBuilder インスタンスに存在するかどうかを示します。 |
![]() | ToString | オーバーライドされます。 この DbConnectionStringBuilder に関連付けられている接続文字列を返します。 |
![]() | TryGetValue | 指定されたキーに対応する値を DbConnectionStringBuilder から取得します。 |

名前 | 説明 | |
---|---|---|
![]() | ClearPropertyDescriptors | 関連付けられている DbConnectionStringBuilder で、PropertyDescriptor オブジェクトのコレクションを削除します。 |
![]() | Finalize | Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。) |
![]() | GetProperties | 指定した HashTable に、この DbConnectionStringBuilder のすべてのプロパティに関する情報を格納します。 |
![]() | MemberwiseClone | 現在の Object の簡易コピーを作成します。 (Object から継承されます。) |

名前 | 説明 | |
---|---|---|
![]() | System.Collections.ICollection.CopyTo | このメンバの説明については、ICollection.CopyTo のトピックを参照してください。 |
![]() | System.Collections.IDictionary.Add | このメンバの説明については、IDictionary.Add のトピックを参照してください。 |
![]() | System.Collections.IDictionary.Contains | このメンバの説明については、IDictionary.Contains のトピックを参照してください。 |
![]() | System.Collections.IDictionary.GetEnumerator | このメンバの説明については、IDictionary.GetEnumerator のトピックを参照してください。 |
![]() | System.Collections.IDictionary.Remove | このメンバの説明については、IDictionary.Remove のトピックを参照してください。 |
![]() | System.Collections.IEnumerable.GetEnumerator | このメンバの説明については、IEnumerable.GetEnumerator のトピックを参照してください。 |
![]() | System.ComponentModel.ICustomTypeDescriptor.GetAttributes | このメンバの説明については、ICustomTypeDescriptor.GetAttributes のトピックを参照してください。 |
![]() | System.ComponentModel.ICustomTypeDescriptor.GetClassName | このメンバの説明については、ICustomTypeDescriptor.GetClassName のトピックを参照してください。 |
![]() | System.ComponentModel.ICustomTypeDescriptor.GetComponentName | このメンバの説明については、ICustomTypeDescriptor.GetComponentName のトピックを参照してください。 |
![]() | System.ComponentModel.ICustomTypeDescriptor.GetConverter | このメンバの説明については、ICustomTypeDescriptor.GetConverter のトピックを参照してください。 |
![]() | System.ComponentModel.ICustomTypeDescriptor.GetDefaultEvent | このメンバの説明については、ICustomTypeDescriptor.GetDefaultEvent のトピックを参照してください。 |
![]() | System.ComponentModel.ICustomTypeDescriptor.GetDefaultProperty | このメンバの説明については、ICustomTypeDescriptor.GetDefaultProperty のトピックを参照してください。 |
![]() | System.ComponentModel.ICustomTypeDescriptor.GetEditor | このメンバの説明については、ICustomTypeDescriptor.GetEditor のトピックを参照してください。 |
![]() | System.ComponentModel.ICustomTypeDescriptor.GetEvents | オーバーロードされます。 |
![]() | System.ComponentModel.ICustomTypeDescriptor.GetProperties | オーバーロードされます。 |
![]() | System.ComponentModel.ICustomTypeDescriptor.GetPropertyOwner | このメンバの説明については、ICustomTypeDescriptor.GetPropertyOwner のトピックを参照してください。 |
![]() | System.Collections.ICollection.IsSynchronized | このメンバの説明については、System.Collections.ICollection.IsSynchronized のトピックを参照してください。 |
![]() | System.Collections.ICollection.SyncRoot | このメンバの説明については、System.Collections.ICollection.SyncRoot のトピックを参照してください。 |
![]() | System.Collections.IDictionary.Item | このメンバの説明については、System.Collections.IDictionary.Item(System.Object) のトピックを参照してください。 |

Weblioに収録されているすべての辞書からDbConnectionStringBuilderを検索する場合は、下記のリンクをクリックしてください。

- DbConnectionStringBuilderのページへのリンク