SqlCommandBuilder Class

On this page

Automatically generates single-table commands used to reconcile changes made to a System.Data.DataSet with the SQL Server.

Syntax

Visual Basic
C#


'Declaration Public Class SqlCommandBuilder Inherits Devart.Common.DbCommandBuilder Implements System.ComponentModel.IComponent, System.IDisposable


public class SqlCommandBuilder : Devart.Common.DbCommandBuilder, System.ComponentModel.IComponent, System.IDisposable

Remarks

The SqlDataAdapter does not automatically generate the SQL statements required to reconcile changes made to a System.Data.DataSet associated with SQL Server. However, you can create a SqlCommandBuilder object that generates SQL statements for single-table updates. After assigning the SqlDataAdapter to the SqlCommandBuilder, it begins to generate any additional SQL statements that you do not set.

The relationship between a SqlDataAdapter and its corresponding SqlCommandBuilder is always one-to-one. To create this correspondence, you set the DataAdapter property of the SqlCommandBuilder object. This causes the SqlCommandBuilder to register itself as a listener, which produces the output of SqlDataAdapter.RowUpdating events that affect the System.Data.DataSet.

To generate INSERT, UPDATE, or DELETE statements, the SqlCommandBuilder uses the SqlDataAdapter.SelectCommand property to retrieve a required set of metadata. If you change the value of SqlDataAdapter.SelectCommand after the metadata has been retrieved (for example, after the first update), you then should call the Devart.Common.DbCommandBuilderBase.RefreshSchema method to update the metadata.

The SqlCommandBuilder also uses the Connection, CommandTimeout, and System.Data.Common.DbCommand.Transaction properties referenced by the SqlDataAdapter.SelectCommand. The user should call Devart.Common.DbCommandBuilderBase.RefreshSchema if any of these properties are modified, or value of the SqlDataAdapter.SelectCommand property itself is changed. Otherwise the SqlDataAdapter.InsertCommand, SqlDataAdapter.UpdateCommand, and SqlDataAdapter.DeleteCommand properties retain their previous values.

If you assign null to corresponding property of SqlDataAdapter, the SqlCommandBuilder will be disassociated from the SqlDataAdapter, and the generated commands will no longer be used.

Note: This class is not available in .NET Standard 1.3 compatible assembly. It is available only in the assembly for full .NET Framework and .NET Standard 2.0 compatible assembly.

Example

The following example uses SqlCommand, along with SqlDataAdapter and SqlConnection, to select rows from SQL Server. The example is passed an initialized System.Data.DataSet, a connection string, a query string that is SQL SELECT statement, and a string that is the name of the SQL Server table. The example then creates a SqlCommandBuilder.

csharp


public DataSet SelectSqlSrvRows(DataSet myDataSet,string myConnection,string mySelectQuery,string myTableName) { SqlConnection myConn = new SqlConnection(myConnection); SqlDataAdapter myDataAdapter = new SqlDataAdapter(); myDataAdapter.SelectCommand = new SqlCommand(mySelectQuery, myConn); SqlCommandBuilder myCommandBuilder = new SqlCommandBuilder(myDataAdapter); myConn.Open(); DataSet myDataSet = new DataSet(); myDataAdapter.Fill(myDataSet, "Departments"); //code to modify data in dataset here //Without the SqlCommandBuilder this line would fail myDataAdapter.Update(myDataSet, "Departments"); myConn.Close(); return myDataSet; }

public DataSet SelectSqlSrvRows(DataSet myDataSet,string myConnection,string mySelectQuery,string myTableName)
{
  SqlConnection myConn = new SqlConnection(myConnection);
  SqlDataAdapter myDataAdapter = new SqlDataAdapter();
  myDataAdapter.SelectCommand = new SqlCommand(mySelectQuery, myConn);
  SqlCommandBuilder myCommandBuilder = new SqlCommandBuilder(myDataAdapter);

  myConn.Open();

  DataSet myDataSet = new DataSet();
  myDataAdapter.Fill(myDataSet, "Departments");

  //code to modify data in dataset here

  //Without the SqlCommandBuilder this line would fail
  myDataAdapter.Update(myDataSet, "Departments");

  myConn.Close();

  return myDataSet;
}

Visual Basic


Public Function SelectSqlSrvRows(myDataSet As DataSet, myConnection As String, mySelectQuery As String, myTableName As String) As DataSet Dim myConn As New SqlConnection(myConnection) Dim myDataAdapter As New SqlDataAdapter() myDataAdapter.SelectCommand = New SqlCommand(mySelectQuery, myConn) Dim myCommandBuilder As SqlCommandBuilder = New SqlCommandBuilder(myDataAdapter) myConn.Open() Dim myDataSet As DataSet = New DataSet myDataAdapter.Fill(myDataSet, "Departments") ' Code to modify data in DataSet here ' Without the SqlCommandBuilder this line would fail. myDataAdapter.Update(myDataSet, "Departments") myConn.Close() SelectSqlSrvRows = myDataSet End Function

Public Function SelectSqlSrvRows(myDataSet As DataSet, myConnection As String, mySelectQuery As String, myTableName As String) As DataSet
  Dim myConn As New SqlConnection(myConnection)
  Dim myDataAdapter As New SqlDataAdapter()
  myDataAdapter.SelectCommand = New SqlCommand(mySelectQuery, myConn)
  Dim myCommandBuilder As SqlCommandBuilder = New SqlCommandBuilder(myDataAdapter)

  myConn.Open()

  Dim myDataSet As DataSet = New DataSet
  myDataAdapter.Fill(myDataSet, "Departments")

  ' Code to modify data in DataSet here

  ' Without the SqlCommandBuilder this line would fail.
  myDataAdapter.Update(myDataSet, "Departments")

  myConn.Close()

  SelectSqlSrvRows = myDataSet
End Function

Inheritance Hierarchy

System.Object
   System.MarshalByRefObject
      System.ComponentModel.Component
         System.Data.Common.DbCommandBuilder
            Devart.Common.DbCommandBuilderBase
               Devart.Common.DbCommandBuilder
                  Devart.Data.SqlServer.SqlCommandBuilder

Reference

SqlCommandBuilder Members
Devart.Data.SqlServer Namespace
SqlDataAdapter Class
SqlConnection Class
SqlCommand Class

Send Feedback