SugarCommandBuilder Class

In This Topic

Syntax
Remarks
Example
Inheritance Hierarchy
Requirements
See Also

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

Syntax

Visual Basic
C#

public class SugarCommandBuilder : Devart.Data.SqlShimCommandBuilder, System.ComponentModel.IComponent, System.IDisposable

'Declaration
 
Public Class SugarCommandBuilder 
   Inherits Devart.Data.SqlShimCommandBuilder
   Implements System.ComponentModel.IComponent, System.IDisposable

Remarks

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

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

To generate INSERT, UPDATE, or DELETE statements, the SugarCommandBuilder uses the SugarDataAdapter.SelectCommand property to retrieve a required set of metadata. If you change the value of SugarDataAdapter.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 SugarCommandBuilder also uses the Connection, CommandTimeout, and System.Data.Common.DbCommand.Transaction properties referenced by the SugarDataAdapter.SelectCommand. The user should call Devart.Common.DbCommandBuilderBase.RefreshSchema if any of these properties are modified, or value of the SugarDataAdapter.SelectCommand property itself is changed. Otherwise the SugarDataAdapter.InsertCommand, SugarDataAdapter.UpdateCommand, and SugarDataAdapter.DeleteCommand properties retain their previous values.

If you assign null to corresponding property of SugarDataAdapter, the SugarCommandBuilder will be disassociated from the SugarDataAdapter, 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 SugarCommand, along with SugarDataAdapter and SugarConnection, to select rows from SugarCRM. 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 SugarCRM table. The example then creates a SugarCommandBuilder.

csharp

public DataSet SelectSugarSrvRows(DataSet myDataSet,string sugarConnection,string mySelectQuery,string myTableName)
{
  SugarConnection myConn = new SugarConnection(sugarConnection);
  SugarDataAdapter myDataAdapter = new SugarDataAdapter();
  myDataAdapter.SelectCommand = new SugarCommand(mySelectQuery, myConn);
  SugarCommandBuilder sugarCommandBuilder = new SugarCommandBuilder(myDataAdapter);

  myConn.Open();

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

  //code to modify data in dataset here

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

  myConn.Close();

  return myDataSet;
}

Visual Basic

Public Function SelectSugarSrvRows(myDataSet As DataSet, sugarConnection As String, mySelectQuery As String, myTableName As String) As DataSet
  Dim myConn As New SugarConnection(sugarConnection)
  Dim myDataAdapter As New SugarDataAdapter()
  myDataAdapter.SelectCommand = New SugarCommand(mySelectQuery, myConn)
  Dim sugarCommandBuilder As SugarCommandBuilder = New SugarCommandBuilder(myDataAdapter)

  myConn.Open()

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

  ' Code to modify data in DataSet here

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

  myConn.Close()

  SelectSugarSrvRows = myDataSet
End Function

Inheritance Hierarchy

System.Object
   System.MarshalByRefObject
      System.ComponentModel.Component
         System.Data.Common.DbCommandBuilder
            Devart.Common.DbCommandBuilderBase
               Devart.Common.DbCommandBuilder
                  Devart.Data.SqlShimCommandBuilder
                     Devart.Data.Sugar.SugarCommandBuilder

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

SugarCommandBuilder Members
Devart.Data.Sugar Namespace
SugarDataAdapter Class
SugarConnection Class
SugarCommand Class

Send Feedback