SqlCommandBuilder クラス

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

SqlCommandBuilder クラス

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

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

Visual Basic (宣言)

Public NotInheritable Class
 SqlCommandBuilder
    Inherits DbCommandBuilder

Visual Basic (使用法)

Dim instance As SqlCommandBuilder

C#

public sealed class SqlCommandBuilder : DbCommandBuilder

C++

public ref class SqlCommandBuilder sealed :
 public DbCommandBuilder

J#

public final class SqlCommandBuilder extends
 DbCommandBuilder

JScript

public final class SqlCommandBuilder extends
 DbCommandBuilder

解説

SqlDataAdapter では、SQL Server のインスタンスに関連付けられた DataSet への変更を調整する Transact-SQL ステートメントが自動的には生成されません。ただし、SqlDataAdapter の SelectCommand プロパティを設定した場合は、単一テーブルを更新する Transact-SQL ステートメントを自動的に生成する SqlCommandBuilder オブジェクトを作成できます。これによって、追加の Transact-SQL ステートメントが、SqlCommandBuilder によって自動的に生成されます。

DataAdapter プロパティを設定すると、SqlCommandBuilder が RowUpdating イベントのリスナとして自動的に登録されます。相互に関連付けることのできる SqlDataAdapter オブジェクトと SqlCommandBuilder オブジェクトは、それぞれ一度に 1 つだけです。

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

また、SelectCommand は、少なくとも 1 つの主キー列または一意な列を返すようにする必要があります。これらの列が存在しない場合は、InvalidOperation 例外が生成され、コマンドは生成されません。

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

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

使用例

SqlCommand を SqlDataAdapter および SqlConnection と共に使用して、データ ソースから行を選択する例を次に示します。この例では、接続文字列、Transact-SQL SELECT ステートメントのクエリ文字列、およびデータベース テーブル名の文字列が渡されます。これらを基に、SqlCommandBuilder を作成します。

Visual Basic

Private Function SelectSqlRows(ByVal
 connectionString As String, _
    ByVal queryString As String,
 ByVal tableName As String)
 As DataSet

    Using connection As New SqlConnection(connectionString)

        Dim adapter As New
 SqlDataAdapter()
        adapter.SelectCommand = New SqlCommand(queryString, connection)
        Dim builder As SqlCommandBuilder =
 New SqlCommandBuilder(adapter)

        connection.Open()

        Dim dataSet As DataSet = New
 DataSet
        adapter.Fill(dataSet, tableName)

        ' Code to modify data in DataSet here 

        ' Without the SqlCommandBuilder this line would fail.
        adapter.Update(dataSet, tableName)

        Return dataSet
    End Using
 End Function

C#

public static DataSet SelectSqlRows(string
 connectionString,
    string queryString, string tableName)
{
    using (SqlConnection connection = new SqlConnection(connectionString))
    {
        SqlDataAdapter adapter = new SqlDataAdapter();
        adapter.SelectCommand = new SqlCommand(queryString, connection);
        SqlCommandBuilder builder = new SqlCommandBuilder(adapter);

        connection.Open();

        DataSet dataSet = new DataSet();
        adapter.Fill(dataSet, tableName);

        //code to modify data in DataSet here

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

        return dataSet;
    }
}

継承階層

System.Object
   System.MarshalByRefObject
     System.ComponentModel.Component
       System.Data.Common.DbCommandBuilder
        System.Data.SqlClient.SqlCommandBuilder

スレッド セーフ

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

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, 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、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
SqlCommandBuilder メンバ
System.Data.SqlClient 名前空間
その他の技術情報
ADO.NET でのデータへの接続およびデータの取得
.NET Framework Data Provider for SQL Server の使用