SqlCommandBuilder クラス

定義

public ref class SqlCommandBuilder sealed : System::ComponentModel::Component

public ref class SqlCommandBuilder sealed : System::Data::Common::DbCommandBuilder

public sealed class SqlCommandBuilder : System.ComponentModel.Component

public sealed class SqlCommandBuilder : System.Data.Common.DbCommandBuilder

type SqlCommandBuilder = class
    inherit Component

type SqlCommandBuilder = class
    inherit DbCommandBuilder

Public NotInheritable Class SqlCommandBuilder
Inherits Component

Public NotInheritable Class SqlCommandBuilder
Inherits DbCommandBuilder

継承

Object

MarshalByRefObject

Component

SqlCommandBuilder

継承

Object

MarshalByRefObject

Component

DbCommandBuilder

SqlCommandBuilder

例

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

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

        builder.GetUpdateCommand();

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

        return dataSet;
    }
}

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 New SqlCommandBuilder(adapter)

        connection.Open()

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

        ' Code to modify data in DataSet here 

        builder.GetUpdateCommand()

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

        Return dataSet
    End Using
End Function

注釈

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

では SqlCommandBuilder 、 プロパティを設定するたびに、イベントの RowUpdating リスナーとして自身が登録されます DataAdapter 。 一度に関連付けることができるのは、1 つまたはSqlDataAdapterSqlCommandBuilder複数のオブジェクトのみです。

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

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

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

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

コンストラクター

プロパティ

メソッド

イベント

適用対象

こちらもご覧ください

• ADO.NET でのデータの取得および変更
• SQL Server と ADO.NET
• ADO.NET の概要