OdbcCommandBuilder クラス

.NET Framework クラス ライブラリ リファレンス

OdbcCommandBuilder クラス

データ ソースに関連付けられた DataSet への変更を調整するための単一テーブル コマンドを自動的に生成します。このクラスは継承できません。

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

Visual Basic (宣言)

Public NotInheritable Class
 OdbcCommandBuilder
    Inherits DbCommandBuilder

Visual Basic (使用法)

Dim instance As OdbcCommandBuilder

C#

public sealed class OdbcCommandBuilder : DbCommandBuilder

C++

public ref class OdbcCommandBuilder sealed
 : public DbCommandBuilder

J#

public final class OdbcCommandBuilder extends
 DbCommandBuilder

JScript

public final class OdbcCommandBuilder extends
 DbCommandBuilder

解説

OdbcDataAdapter では、データ ソースに関連付けられた DataSet への変更を調整するために必要な SQL ステートメントが、自動的に生成されることはありません。ただし、OdbcDataAdapter の SelectCommand プロパティを設定して、単一テーブルを更新する SQL ステートメントを自動的に生成する OdbcCommandBuilder オブジェクトを作成できます。続いて、OdbcCommandBuilder により、未設定の SQL ステートメントが追加で自動生成されます。

OdbcDataAdapter とそれに対応する OdbcCommandBuilder 間のリレーションシップは、常に 1 対 1 です。この対応を作成するには、OdbcCommandBuilder オブジェクトの OdbcDataAdapter プロパティを設定します。その結果、OdbcCommandBuilder はリスナとして登録され、DataSet を対象とする RowUpdating イベントの出力を生成します。

OdbcCommandBuilder では、INSERT、UPDATE、または DELETE ステートメントを生成するために、SelectCommand プロパティを使用して必要なメタデータ セットが取得されます。最初の更新の後など、メタデータが取得された後で SelectCommand の値を変更した場合は、続けて RefreshSchema メソッドを呼び出してメタデータを更新する必要があります。

メモ
SelectCommand プロパティに割り当てられた SELECT ステートメントで別名の列名が使用されている場合は、それを使用した INSERT、UPDATE、および DELETE ステートメントは正しくないか、失敗する可能性があります。基になる ODBC ドライバが別名の列名に対応する適切な元の列名を (SQLColAttribute の SQL_DESC_BASE_COLUMN_NAME 値を使用して) 提供できない場合、生成された INSERT、UPDATE、および DELETE ステートメントに別名が使用される可能性があります。たとえば、Microsoft ODBC Driver for Oracle は、元の列名として別名を返します。そのため、生成された INSERT、UPDATE、および DELETE ステートメントでエラーが発生します。

また、OdbcCommandBuilder では、SelectCommand が参照する Connection、CommandTimeout、および Transaction プロパティも使用されます。これらの 1 つ以上のプロパティを変更した場合、または SelectCommand プロパティの値を変更した場合は、ユーザーが RefreshSchema を呼び出す必要があります。この操作を行わないと、InsertCommand、UpdateCommand、および DeleteCommand プロパティが、変更前の値のままになります。

Dispose を呼び出すと、OdbcCommandBuilder と OdbcDataAdapter の関連付けが解除され、生成されたコマンドは使用されなくなります。

使用例

OdbcCommand を OdbcDataAdapter および OdbcConnection と共に使用して、データ ソースから行を選択する例を次に示します。この例では、初期化済みの DataSet、接続文字列、クエリ文字列 (SQL SELECT ステートメント)、およびデータ ソース テーブル名の文字列が渡されます。この例では、続いて、OdbcCommandBuilder を作成します。

Visual Basic

Public Function SelectOdbcSrvRows( _
    ByVal connectionString As String,
 ByVal queryString As String,
 _
    ByVal tableName As String)
 As DataSet

    Dim dataSet As DataSet = New
 DataSet

    Using connection As New OdbcConnection(connectionString)
        Dim adapter As New
 OdbcDataAdapter()
        adapter.SelectCommand = _
            New OdbcCommand(queryString, connection)
        Dim builder As OdbcCommandBuilder =
 _
            New OdbcCommandBuilder(adapter)

        connection.Open()

        adapter.Fill(dataSet, tableName)

        ' Code to modify data in DataSet here 

        ' Without the OdbcCommandBuilder this line would fail.
        adapter.Update(dataSet, tableName)
    End Using

    Return dataSet
End Function

C#

public static DataSet SelectOdbcSrvRows(string
 connectionString,
    string queryString, string tableName)
{
    DataSet dataSet = new DataSet();
    using (OdbcConnection connection = new
 OdbcConnection(connectionString))
    {
        OdbcDataAdapter adapter = new OdbcDataAdapter();
        adapter.SelectCommand =
            new OdbcCommand(queryString, connection);
        OdbcCommandBuilder builder =
            new OdbcCommandBuilder(adapter);

        connection.Open();

        adapter.Fill(dataSet, tableName);

        //code to modify data in DataSet here

        //Without the OdbcCommandBuilder this line would fail
        adapter.Update(dataSet, tableName);
    }
    return dataSet;
}

継承階層

System.Object
   System.MarshalByRefObject
     System.ComponentModel.Component
       System.Data.Common.DbCommandBuilder
        System.Data.Odbc.OdbcCommandBuilder

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

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 によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1

参照

関連項目
OdbcCommandBuilder メンバ
System.Data.Odbc 名前空間
その他の技術情報
コマンドの自動生成