dotConnect for Magento Documentation
Devart.Data.Magento Namespace / MagentoCommandBuilder Class
Members Example

In This Topic
    MagentoCommandBuilder Class
    In This Topic
    Automatically generates single-table commands used to reconcile changes made to a System.Data.DataSet with the Magento.
    Syntax
    'Declaration
     
    Public Class MagentoCommandBuilder 
       Inherits Devart.Data.SqlShimCommandBuilder
       Implements System.ComponentModel.IComponentSystem.IDisposable 
    Remarks

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

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

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

    If you assign null to corresponding property of MagentoDataAdapter, the MagentoCommandBuilder will be disassociated from the MagentoDataAdapter, 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 MagentoCommand, along with MagentoDataAdapter and MagentoConnection, to select rows from Magento. 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 Magento table. The example then creates a MagentoCommandBuilder.
    public DataSet SelectMagentoSrvRows(DataSet myDataSet,string magentoConnection,string mySelectQuery,string myTableName)
    {
      MagentoConnection myConn = new MagentoConnection(magentoConnection);
      MagentoDataAdapter myDataAdapter = new MagentoDataAdapter();
      myDataAdapter.SelectCommand = new MagentoCommand(mySelectQuery, myConn);
      MagentoCommandBuilder magentoCommandBuilder = new MagentoCommandBuilder(myDataAdapter);
    
      myConn.Open();
    
      DataSet myDataSet = new DataSet();
      myDataAdapter.Fill(myDataSet, "Departments");
    
      //code to modify data in dataset here
    
      //Without the MagentoCommandBuilder this line would fail
      myDataAdapter.Update(myDataSet, "Departments");
    
      myConn.Close();
    
      return myDataSet;
    }
    Public Function SelectMagentoSrvRows(myDataSet As DataSet, magentoConnection As String, mySelectQuery As String, myTableName As String) As DataSet
      Dim myConn As New MagentoConnection(magentoConnection)
      Dim myDataAdapter As New MagentoDataAdapter()
      myDataAdapter.SelectCommand = New MagentoCommand(mySelectQuery, myConn)
      Dim magentoCommandBuilder As MagentoCommandBuilder = New MagentoCommandBuilder(myDataAdapter)
    
      myConn.Open()
    
      Dim myDataSet As DataSet = New DataSet
      myDataAdapter.Fill(myDataSet, "Departments")
    
      ' Code to modify data in DataSet here
    
      ' Without the MagentoCommandBuilder this line would fail.
      myDataAdapter.Update(myDataSet, "Departments")
    
      myConn.Close()
    
      SelectMagentoSrvRows = 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.Magento.MagentoCommandBuilder

    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

    See Also