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
接続文字列使用


このページでは「.NET Framework クラス ライブラリ リファレンス」からOdbcConnectionStringBuilderを検索した結果を表示しています。
Weblioに収録されているすべての辞書からOdbcConnectionStringBuilderを検索する場合は、下記のリンクをクリックしてください。
 全ての辞書からOdbcConnectionStringBuilder を検索

英和和英テキスト翻訳>> Weblio翻訳
英語⇒日本語日本語⇒英語
  

辞書ショートカット

すべての辞書の索引

「OdbcConnectionStringBuilder」の関連用語

OdbcConnectionStringBuilderのお隣キーワード
検索ランキング

   

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



OdbcConnectionStringBuilderのページの著作権
Weblio 辞書 情報提供元は 参加元一覧 にて確認できます。

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

©2025 GRAS Group, Inc.RSS