MailChimpCommandBuilder Class

In This Topic

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

Syntax

Visual Basic
C#

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

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

Remarks

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

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

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

If you assign null to corresponding property of MailChimpDataAdapter, the MailChimpCommandBuilder will be disassociated from the MailChimpDataAdapter, 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 MailChimpCommand, along with MailChimpDataAdapter and MailChimpConnection, to select rows from Mailchimp. 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 Mailchimp table. The example then creates a MailChimpCommandBuilder.

csharp

public DataSet SelectMailChimpSrvRows(DataSet myDataSet,string mailchimpConnection,string mySelectQuery,string myTableName)
{
  MailChimpConnection myConn = new MailChimpConnection(mailchimpConnection);
  MailChimpDataAdapter myDataAdapter = new MailChimpDataAdapter();
  myDataAdapter.SelectCommand = new MailChimpCommand(mySelectQuery, myConn);
  MailChimpCommandBuilder mailchimpCommandBuilder = new MailChimpCommandBuilder(myDataAdapter);

  myConn.Open();

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

  //code to modify data in dataset here

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

  myConn.Close();

  return myDataSet;
}

Visual Basic

Public Function SelectMailChimpSrvRows(myDataSet As DataSet, mailchimpConnection As String, mySelectQuery As String, myTableName As String) As DataSet
  Dim myConn As New MailChimpConnection(mailchimpConnection)
  Dim myDataAdapter As New MailChimpDataAdapter()
  myDataAdapter.SelectCommand = New MailChimpCommand(mySelectQuery, myConn)
  Dim mailchimpCommandBuilder As MailChimpCommandBuilder = New MailChimpCommandBuilder(myDataAdapter)

  myConn.Open()

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

  ' Code to modify data in DataSet here

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

  myConn.Close()

  SelectMailChimpSrvRows = 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.MailChimp.MailChimpCommandBuilder

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

MailChimpCommandBuilder Members
Devart.Data.MailChimp Namespace
MailChimpDataAdapter Class
MailChimpConnection Class
MailChimpCommand Class

Send Feedback