OdbcConnectionStringBuilderとは? わかりやすく解説

OdbcConnectionStringBuilder クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

OdbcConnection クラスで使用する接続文字列の内容の作成と管理を簡単に実行できるようにします。

名前空間: System.Data.Odbc
アセンブリ: System.Data (system.data.dll 内)
構文構文

Public NotInheritable Class
 OdbcConnectionStringBuilder
    Inherits DbConnectionStringBuilder
Dim instance As OdbcConnectionStringBuilder
public sealed class OdbcConnectionStringBuilder
 : DbConnectionStringBuilder
public ref class OdbcConnectionStringBuilder
 sealed : public DbConnectionStringBuilder
public final class OdbcConnectionStringBuilder
 extends DbConnectionStringBuilder
public final class OdbcConnectionStringBuilder
 extends DbConnectionStringBuilder
解説解説

接続文字列ビルダにより、クラスのプロパティとメソッドを使用して、構文的に正確な接続文字列をプログラムで作成したり、既存の接続文字列を解析および再構築したりできます。接続文字列ビルダは、ODBC 接続がサポートする既知のキー/値ペアに対応した、厳密に型指定されたプロパティを提供するほか、開発者が他の接続文字列値に対して任意のキー/値ペアを追加することもできます。

接続文字列をアプリケーション内で生成する必要がある場合、OdbcConnectionStringBuilder クラスを使用して、接続文字列を生成および修正できます。また、このクラスを利用することで、アプリケーションの構成ファイルに格納される接続文字列の管理が容易になります。OdbcConnectionStringBuilder によって実行されるチェックは、既知のキー/値ペアに限定されます。したがって、このクラスを使用した場合、無効な接続文字列が生成される場合もあります。既知のキーと、OdbcConnectionStringBuilder クラス内の対応するプロパティ、およびその既定値の一覧を次の表に示します。これらの特定の値以外にも、開発者は任意のキー/値ペアを、OdbcConnectionStringBuilder のインスタンス内に保持されるコレクションに追加できます。

接続文字列中の値 (Driver 値を除く) に、セミコロン (;) が含まれていた場合、OdbcConnectionStringBuilder は、その値の両側に引用符を追加して接続文字列に埋め込みます。セミコロンが使用される頻度の高い Driver 値については、この問題を回避するため、OdbcConnectionStringBuilder クラスによって常に両側に中かっこが追加されます。ODBC の仕様では、セミコロンを含むドライバ値は中かっこで囲むという決まりがあります。このクラスでは、この処理が自動的に行われます。

Item プロパティは、安全ではないコードの挿入が試みられた場合も、適切に処理します。たとえば、次のコードでは、既定の Item プロパティ (C# ではインデクサ) を使用することで、入れ子になったキー/値ペアが適切にエスケープされています。

[Visual Basic]

Dim builder As _
 New System.Data.Odbc.OdbcConnectionStringBuilder
' Take advantage of the Driver property. 
builder.Driver = "SQL Server"
builder("Server") = "MyServer;NewValue=Bad"
Console.WriteLine(builder.ConnectionString)

[C#]

System.Data.Odbc.OdbcConnectionStringBuilder builder = 
  new System.Data.Odbc.OdbcConnectionStringBuilder();
// Take advantage of the Driver property. 
builder.Driver = "SQL Server";
builder["Server"] = "MyServer;NewValue=Bad";
Console.WriteLine(builder.ConnectionString);

結果は次の接続文字列になり、無効な値は安全な方法で処理されます。

Driver={SQL Server};Server="MyServer;NewValue=Bad"
使用例使用例

次のコンソール アプリケーションでは、いくつかの ODBC データベースで使用される接続文字列を作成します。最初に、Microsoft Access データベース用の接続文字列を作成します。次に、IBM DB2 データベース用の接続文字列を作成します。また、既存の接続文字列を解析し、接続文字列の内容に対して各種の操作を行う例が示されています。

メモメモ

この例には、OdbcConnectionStringBuilder と接続文字列がどのように連携するかを示すパスワードが含まれています。アプリケーションでは、Windows 認証の使用をお勧めします。パスワードを使用する必要がある場合は、ハードコーディングされたパスワードをアプリケーションに組み込まないでください。

Imports System.Data.Odbc    

Module Module1
  Sub Main()
    Dim builder As New OdbcConnectionStringBuilder()
    builder.Driver = "Microsoft Access Driver (*.mdb)"

    ' Call the Add method to explicitly add key/value
    ' pairs to the internal collection.
    builder.Add("Dbq", "C:\info.mdb")
    builder.Add("Uid", "Admin")
    builder.Add("Pwd", "pass!word1")

    Console.WriteLine(builder.ConnectionString)
    Console.WriteLine()

    ' Clear current values and reset known keys to their
    ' default values.
    builder.Clear()

    ' Pass the OdbcConnectionStringBuilder an existing 
    ' connection string, and you can retrieve and
    ' modify any of the elements.
    builder.ConnectionString = _
        "driver={IBM DB2 ODBC DRIVER};Database=SampleDB;"
 & _
        "hostname=SampleServerName;port=SamplePortNum;"
 & _
        "protocol=TCPIP;uid=Admin;pwd=pass!word1"

    Console.WriteLine("protocol = " & builder("protocol").ToString())
    Console.WriteLine()

    ' Modify existing items:
    builder("uid") = "NewUser"
    builder("pwd") = "Pass@word2"

    ' Call the Remove method to remove items from 
    ' the collection of key/value pairs.
    builder.Remove("port")

    ' Note that calling Remove on a nonexistent item does not
    ' throw an exception.
    builder.Remove("BadItem")
    Console.WriteLine(builder.ConnectionString)
    Console.WriteLine()

    ' The Item property is the default for the class, 
    ' and setting the Item property adds the value, if 
    ' necessary.
    builder("NewKey") = "newValue"
    Console.WriteLine(builder.ConnectionString)

    Console.WriteLine("Press Enter to finish.")
    Console.ReadLine()
  End Sub
End Module
using System.Data.Odbc;

class Program
{
    static void Main()
    {
        OdbcConnectionStringBuilder builder = 
            new OdbcConnectionStringBuilder();
        builder.Driver = "Microsoft Access Driver (*.mdb)";

        // Call the Add method to explicitly add key/value
        // pairs to the internal collection.
        builder.Add("Dbq", "C:\\info.mdb");
        builder.Add("Uid", "Admin");
        builder.Add("Pwd", "pass!word1");

        Console.WriteLine(builder.ConnectionString);
        Console.WriteLine();

        // Clear current values and reset known keys to their
        // default values.
        builder.Clear();

        // Pass the OdbcConnectionStringBuilder an existing 
        // connection string, and you can retrieve and
        // modify any of the elements.
        builder.ConnectionString =
            "driver={IBM DB2 ODBC DRIVER};Database=SampleDB;" +
            "hostname=SampleServerName;port=SamplePortNum;" +
            "protocol=TCPIP;uid=Admin;pwd=pass!word1";

        Console.WriteLine("protocol = " 
            + builder["protocol"].ToString());
        Console.WriteLine();

        // Modify existing items.
        builder["uid"] = "NewUser";
        builder["pwd"] = "Pass@word2";

        // Call the Remove method to remove items from 
        // the collection of key/value pairs.
        builder.Remove("port");

        // Note that calling Remove on a nonexistent item does not
        // throw an exception.
        builder.Remove("BadItem");
        Console.WriteLine(builder.ConnectionString);
        Console.WriteLine();

        // Setting the indexer adds the associated value, if 
        // necessary.
        builder["NewKey"] = "newValue";
        Console.WriteLine(builder.ConnectionString);

        Console.WriteLine("Press Enter to finish.");
        Console.ReadLine();
    }
}
継承階層継承階層
System.Object
   System.Data.Common.DbConnectionStringBuilder
    System.Data.Odbc.OdbcConnectionStringBuilder
スレッド セーフスレッド セーフ
この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。
プラットフォームプラットフォーム
バージョン情報バージョン情報
参照参照

OdbcConnectionStringBuilder コンストラクタ ()


OdbcConnectionStringBuilder コンストラクタ (String)

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

OdbcConnectionStringBuilder クラスの新しいインスタンスを初期化します。引数に渡した接続文字列によって、インスタンスの内部的な接続情報のデータが提供されます。

名前空間: System.Data.Odbc
アセンブリ: System.Data (system.data.dll 内)
構文構文

Public Sub New ( _
    connectionString As String _
)
Dim connectionString As String

Dim instance As New OdbcConnectionStringBuilder(connectionString)
public OdbcConnectionStringBuilder (
    string connectionString
)
public:
OdbcConnectionStringBuilder (
    String^ connectionString
)
public OdbcConnectionStringBuilder (
    String connectionString
)
public function OdbcConnectionStringBuilder
 (
    connectionString : String
)

パラメータ

connectionString

この情報を基にオブジェクトの内部的な接続情報が生成されます。この情報が解析され、キー/値のペアが生成されます。

例外例外
例外の種類条件

ArgumentException

接続文字列が正しい書式になっていません。たとえば、キー/値ペアに "=" が欠落していることが考えられます。

解説解説

コンストラクタに接続文字列を渡すことも、ConnectionString プロパティを明示的に設定することもできます。どちらも動作は同じです。

使用例使用例

次の例では、複数の OdbcConnectionStringBuilder インスタンスを作成し、それぞれの場合について異なる接続文字列をコンストラクタに渡しています。ConnectionString プロパティを取得すると、接続文字列における要素の順序が変わる場合があります。定義済みの "Dsn" や "Driver" 以外のキーは、OdbcConnectionStringBuilder クラスによって小文字に変換されます。

メモメモ

この例には、OdbcConnectionStringBuilder と接続文字列がどのように連携するかを示すパスワードが含まれています。アプリケーションでは、Windows 認証の使用をお勧めします。パスワードを使用する必要がある場合は、ハードコーディングされたパスワードをアプリケーションに組み込まないでください。

Imports System.Data.Odbc    

Module Module1
  Sub Main()
    Try
      ' Build an empty instance, just to see
      ' the contents of the keys.
      DumpBuilderContents("")

      ' Create a SQL Server connection string.
      DumpBuilderContents("Driver={SQL Server};Server=(local);Database=AdventureWorks;Uid=ab;Pwd=pass@word1")

      ' Create an Access connection string.
      DumpBuilderContents("Driver={Microsoft Access Driver (*.mdb)};Dbq=C:\info.mdb;Exclusive=1;Uid=admin;Pwd=pass@word1")

      ' Create an Oracle connection string.
      DumpBuilderContents("Driver={Microsoft ODBC for Oracle};Server=OracleServer.world;Uid=Admin;Pwd=pass@word1;")

      ' Create a Sybase connection string.
      DumpBuilderContents("Driver={SYBASE ASE ODBC Driver};Srvr=SomeServer;Uid=admin;Pwd=pass@word1")

      Console.WriteLine("Press any key to finish.")
      Console.ReadLine()

    Catch ex As System.ArgumentException
      Console.WriteLine("Error: " & ex.Message)
    End Try
  End Sub

  Private Sub DumpBuilderContents(ByVal
 connectString As String)
    Dim builder As New OdbcConnectionStringBuilder(connectString)
    Console.WriteLine("=================")
    Console.WriteLine("Original connectString   = "
 & connectString)
    Console.WriteLine("builder.ConnectionString = "
 & builder.ConnectionString)
    For Each key As String
 In builder.Keys
      Console.WriteLine(key & "=" & builder.Item(key).ToString)
    Next
  End Sub
End Module
using System.Data.Odbc;

class Program
{
    static void Main()
    {
        try
        {
            // Build an empty instance, just to see
            // the contents of the keys.
            DumpBuilderContents("");

            // Create a SQL Server connection string.
            DumpBuilderContents("Driver={SQL Server};Server=(local);Database=AdventureWorks;Uid=ab;Pwd=pass@word1");

            // Create an Access connection string.
            DumpBuilderContents(@"Driver={Microsoft Access Driver (*.mdb)};Dbq=C:\info.mdb;Exclusive=1;Uid=admin;Pwd=pass@word1");

            // Create an Oracle connection string.
            DumpBuilderContents("Driver={Microsoft ODBC for
 Oracle};Server=OracleServer.world;Uid=Admin;Pwd=pass@word1;");

            // Create a Sybase connection string.
            DumpBuilderContents("Driver={SYBASE ASE ODBC Driver};Srvr=SomeServer;Uid=admin;Pwd=pass@word1");

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

        }
        catch (System.ArgumentException ex)
        {
            Console.WriteLine("Error: " + ex.Message);
        }
    }

    private static void
 DumpBuilderContents(string connectString)
    {
        OdbcConnectionStringBuilder builder =
            new OdbcConnectionStringBuilder(connectString);
        Console.WriteLine("=================");
        Console.WriteLine("Original connectString   = " + connectString);
        Console.WriteLine("builder.ConnectionString = " + builder.ConnectionString);
        foreach (string key in
 builder.Keys)
        {
            Console.WriteLine(key + "=" + builder[key].ToString());
        }
    }
}
プラットフォームプラットフォーム
バージョン情報バージョン情報
参照参照
関連項目
OdbcConnectionStringBuilder クラス
OdbcConnectionStringBuilder メンバ
System.Data.Odbc 名前空間
その他の技術情報
Building Connection Strings
接続文字列の使用

OdbcConnectionStringBuilder コンストラクタ

OdbcConnectionStringBuilder クラスの新しいインスタンスを初期化します。 Building Connection Strings 接続文字列の使用
オーバーロードの一覧オーバーロードの一覧

名前 説明
OdbcConnectionStringBuilder () OdbcConnectionStringBuilder クラスの新しいインスタンスを初期化します。
OdbcConnectionStringBuilder (String) OdbcConnectionStringBuilder クラスの新しいインスタンスを初期化します。引数に渡した接続文字列によって、インスタンスの内部的な接続情報のデータが提供されます。
参照参照

関連項目

OdbcConnectionStringBuilder クラス
OdbcConnectionStringBuilder メンバ
System.Data.Odbc 名前空間

その他の技術情報

Building Connection Strings
接続文字列の使用
Building Connection Strings
接続文字列の使用

OdbcConnectionStringBuilder プロパティ


パブリック プロパティパブリック プロパティ

  名前 説明
パブリック プロパティ BrowsableConnectionString  ConnectionString プロパティが Visual Studio デザイナに表示できるかどうかを指定する値を取得または設定します。 ( DbConnectionStringBuilder から継承されます。)
パブリック プロパティ ConnectionString  DbConnectionStringBuilder に関連付けられる接続文字列を取得または設定します。 ( DbConnectionStringBuilder から継承されます。)
パブリック プロパティ Count  ConnectionString プロパティに格納されている、現在のキー数を取得します。 ( DbConnectionStringBuilder から継承されます。)
パブリック プロパティ Driver 接続に関連付けられた ODBC ドライバの名前を取得または設定します。
パブリック プロパティ Dsn 接続に関連付けられた データ ソース名 (DSN) を取得または設定します。
パブリック プロパティ IsFixedSize  DbConnectionStringBuilder が固定サイズかどうかを示す値を取得します。 ( DbConnectionStringBuilder から継承されます。)
パブリック プロパティ IsReadOnly  DbConnectionStringBuilder が読み取り専用かどうかを示す値を取得します。 ( DbConnectionStringBuilder から継承されます。)
パブリック プロパティ Item オーバーライドされます。 指定したキーに関連付けられている値を取得または設定します。C# では、このプロパティはインデクサです。
パブリック プロパティ Keys オーバーライドされます。 OdbcConnectionStringBuilder 内のキーを格納している ICollection を取得します。
パブリック プロパティ Values  DbConnectionStringBuilder 内の値を格納している ICollection を取得します。 ( DbConnectionStringBuilder から継承されます。)
参照参照

関連項目

OdbcConnectionStringBuilder クラス
System.Data.Odbc 名前空間

その他の技術情報

Building Connection Strings
接続文字列の使用

OdbcConnectionStringBuilder メソッド


パブリック メソッドパブリック メソッド

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

関連項目

OdbcConnectionStringBuilder クラス
System.Data.Odbc 名前空間

その他の技術情報

Building Connection Strings
接続文字列の使用

OdbcConnectionStringBuilder メンバ

OdbcConnection クラスで使用する接続文字列の内容の作成と管理を簡単に実行できるようにします。

OdbcConnectionStringBuilder データ型で公開されるメンバを以下の表に示します。


パブリック コンストラクタパブリック コンストラクタ
  名前 説明
パブリック メソッド OdbcConnectionStringBuilder オーバーロードされます。 OdbcConnectionStringBuilder クラスの新しいインスタンスを初期化します。
パブリック プロパティパブリック プロパティ
  名前 説明
パブリック プロパティ BrowsableConnectionString  ConnectionString プロパティが Visual Studio デザイナに表示できるかどうかを指定する値を取得または設定します。(DbConnectionStringBuilder から継承されます。)
パブリック プロパティ ConnectionString  DbConnectionStringBuilder に関連付けられる接続文字列を取得または設定します。(DbConnectionStringBuilder から継承されます。)
パブリック プロパティ Count  ConnectionString プロパティに格納されている、現在のキー数を取得します。(DbConnectionStringBuilder から継承されます。)
パブリック プロパティ Driver 接続に関連付けられた ODBC ドライバの名前を取得または設定します。
パブリック プロパティ Dsn 接続に関連付けられた データ ソース名 (DSN) を取得または設定します。
パブリック プロパティ IsFixedSize  DbConnectionStringBuilder が固定サイズかどうかを示す値を取得します。(DbConnectionStringBuilder から継承されます。)
パブリック プロパティ IsReadOnly  DbConnectionStringBuilder が読み取り専用かどうかを示す値を取得します。(DbConnectionStringBuilder から継承されます。)
パブリック プロパティ Item オーバーライドされます。 指定したキーに関連付けられている値を取得または設定します。C# では、このプロパティはインデクサです。
パブリック プロパティ Keys オーバーライドされます。 OdbcConnectionStringBuilder 内のキーを格納している ICollection を取得します。
パブリック プロパティ Values  DbConnectionStringBuilder 内の値を格納している ICollection を取得します。(DbConnectionStringBuilder から継承されます。)
パブリック メソッドパブリック メソッド
( プロテクト メソッド も参照)
  名前 説明
パブリック メソッド Add  指定したキーおよび値を持つエントリを DbConnectionStringBuilder に追加します。 (DbConnectionStringBuilder から継承されます。)
パブリック メソッド AppendKeyValuePair  オーバーロードされます。 効率的かつ安全に、既存の StringBuilder オブジェクトにキーと値を追加できます。 (DbConnectionStringBuilder から継承されます。)
パブリック メソッド Clear オーバーライドされます。 OdbcConnectionStringBuilder インスタンスの内容を消去します。
パブリック メソッド ContainsKey オーバーライドされます。 OdbcConnectionStringBuilder に特定のキーが格納されているかどうかを判断します。
パブリック メソッド Equals  オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
パブリック メソッド EquivalentTo  この DbConnectionStringBuilder オブジェクト内の接続情報と、指定したオブジェクト内の接続情報を比較します。 (DbConnectionStringBuilder から継承されます。)
パブリック メソッド GetHashCode  特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
パブリック メソッド GetType  現在のインスタンスの Type を取得します。 (Object から継承されます。)
パブリック メソッド ReferenceEquals  指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
パブリック メソッド Remove オーバーライドされます。 指定したキーを持つエントリを OdbcConnectionStringBuilder インスタンスから削除します。
パブリック メソッド ShouldSerialize  指定されたキーが、この DbConnectionStringBuilder インスタンスに存在するかどうかを示します。 (DbConnectionStringBuilder から継承されます。)
パブリック メソッド ToString  この DbConnectionStringBuilder に関連付けられている接続文字列を返します。 (DbConnectionStringBuilder から継承されます。)
パブリック メソッド TryGetValue オーバーライドされます。 指定されたキーに対応する値を OdbcConnectionStringBuilder から取得します。
プロテクト メソッドプロテクト メソッド
参照参照

関連項目

OdbcConnectionStringBuilder クラス
System.Data.Odbc 名前空間

その他の技術情報

Building Connection Strings
接続文字列の使用



英和和英テキスト翻訳

英語⇒日本語日本語⇒英語

辞書ショートカット

すべての辞書の索引

「OdbcConnectionStringBuilder」の関連用語

OdbcConnectionStringBuilderのお隣キーワード

   

英語⇒日本語
日本語⇒英語
   



OdbcConnectionStringBuilderのページの著作権

   
日本マイクロソフト株式会社日本マイクロソフト株式会社
© 2026 Microsoft.All rights reserved.

©2026 GRAS Group, Inc.RSS