SalesforceCommandBuilder Class

In This Topic

Syntax
Remarks
Example
Inheritance Hierarchy
See Also

Automatically generates single-table commands used to reconcile changes made to a System.Data.DataSet with the Salesforce.com or Database.com.

Syntax

Visual Basic
C#

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

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

Remarks

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

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

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

If you assign null to corresponding property of SalesforceDataAdapter, the SalesforceCommandBuilder will be disassociated from the SalesforceDataAdapter, 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 SalesforceCommand, along with SalesforceDataAdapter and SalesforceConnection, to select rows from Salesforce.com or Database.com. 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 Salesforce.com or Database.com table. The example then creates a SalesforceCommandBuilder.

csharp

public DataSet SelectSalesforceSrvRows(DataSet myDataSet,string salesforceConnection,string mySelectQuery,string myTableName)
{
  SalesforceConnection myConn = new SalesforceConnection(salesforceConnection);
  SalesforceDataAdapter myDataAdapter = new SalesforceDataAdapter();
  myDataAdapter.SelectCommand = new SalesforceCommand(mySelectQuery, myConn);
  SalesforceCommandBuilder salesforceCommandBuilder = new SalesforceCommandBuilder(myDataAdapter);

  myConn.Open();

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

  //code to modify data in dataset here

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

  myConn.Close();

  return myDataSet;
}

Visual Basic

Public Function SelectSalesforceSrvRows(myDataSet As DataSet, salesforceConnection As String, mySelectQuery As String, myTableName As String) As DataSet
  Dim myConn As New SalesforceConnection(salesforceConnection)
  Dim myDataAdapter As New SalesforceDataAdapter()
  myDataAdapter.SelectCommand = New SalesforceCommand(mySelectQuery, myConn)
  Dim salesforceCommandBuilder As SalesforceCommandBuilder = New SalesforceCommandBuilder(myDataAdapter)

  myConn.Open()

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

  ' Code to modify data in DataSet here

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

  myConn.Close()

  SelectSalesforceSrvRows = 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.Salesforce.SalesforceCommandBuilder

Reference

SalesforceCommandBuilder Members
Devart.Data.Salesforce Namespace
SalesforceDataAdapter Class
SalesforceConnection Class
SalesforceCommand Class

Send Feedback