ADO.NET Provider for Microsoft Dataverse

Build 23.0.8839

Batch Processing

The CData ADO.NET Provider for Microsoft Dataverse enables you to take advantage of the bulk load support in Microsoft Dataverse through CDSDataAdapters. You can use the Batch API to execute related SQL data manipulation statements simultaneously. The provider translates all SQL queries in the batch into a single request.

Using the ADO.NET Batch API

Performing a batch update consists of the following basic steps:

  1. Define custom parameterized SQL statements in CDSCommand objects.
  2. Set the UpdatedRowSource property of the CDSCommand object to "UpdateRowSource.None".
  3. Assign the CDSCommand objects to the CDSDataAdapter.
  4. Add the parameters to the command.
  5. Call the CDSDataAdapter's Update method. Pass in a DataSet or DataTable containing your changes.

Controlling Batch Size

Depending on factors such as the size of the request, your network resources, and the performance of the server, you may gain performance by executing several smaller batch requests. You can control the size of each batch by setting the CDSDataAdapter's UpdateBatchSize property to a positive integer.

Bulk INSERT

The following code prepares a single batch that inserts records in bulk and retrieves the new records' Ids. The example executes a batch INSERT of new DataRows, which have the "Added" state.

C#

CDSDataAdapter adapter = new CDSDataAdapter();

using (CDSConnection conn = new CDSConnection("InitiateOAuth=GETANDREFRESH;OrganizationUrl=https://myaccount.crm.dynamics.com/;")) {
  conn.Open();
  adapter.InsertCommand = conn.CreateCommand();
  adapter.InsertCommand.CommandText = "INSERT INTO Accounts (Name) VALUES (@Name)";
  adapter.InsertCommand.UpdatedRowSource = UpdateRowSource.None;
  adapter.InsertCommand.Parameters.Add("@Name", "Name");

  DataTable batchDataTable = new DataTable();
  batchDataTable.Columns.Add("Name", typeof(string));
  batchDataTable.Rows.Add("Jon Doe");
  batchDataTable.Rows.Add("John");
  adapter.UpdateBatchSize = 2;
  adapter.Update(batchDataTable);

  CDSCommand cmd = new CDSCommand("SELECT * FROM LastResultInfo#TEMP", conn);
  adapter = new CDSDataAdapter(cmd);
  DataTable res = new DataTable();
  adapter.Fill(res);
  foreach (DataRow row in res.Rows) 
    foreach(DataColumn col in res.Columns)
      Console.Write("{0}: {1}", col.ColumnName, row[col]);
}

VB.NET

 
Dim adapter As New CDSDataAdapter()

Using conn As New CDSConnection("InitiateOAuth=GETANDREFRESH;OrganizationUrl=https://myaccount.crm.dynamics.com/;")
  conn.Open()
  adapter.InsertCommand = conn.CreateCommand()
  adapter.InsertCommand.CommandText = "INSERT INTO Accounts (accountid) VALUES (@Name)"
  adapter.InsertCommand.UpdatedRowSource = UpdateRowSource.None
  adapter.InsertCommand.Parameters.Add("@Name", "Name")

  Dim batchDataTable As New DataTable()
  batchDataTable.Columns.Add("Name", GetType(String))
  batchDataTable.Rows.Add("John")
  batchDataTable.Rows.Add("Jon Doe")
  adapter.UpdateBatchSize = 2
  adapter.Update(batchDataTable)

  Dim cmd As New CDSCommand("SELECT * FROM LastResultInfo#TEMP", conn)
  adapter = New CDSDataAdapter(cmd)
  Dim res As New DataTable()
  adapter.Fill(res)
  For Each row As DataRow In res.Rows 
    For Each col As DataColumn In res.Columns
      Console.WriteLine("{0}: {1}", col.ColumnName, row(col))
    Next
  Next
End Using

Bulk Update

A batch update additionally requires the primary key of each row to update. The following example executes a batch for all DataRow records with a "Modified" state:

C#

CDSDataAdapter adapter = new CDSDataAdapter();

using (CDSConnection conn = new CDSConnection("InitiateOAuth=GETANDREFRESH;OrganizationUrl=https://myaccount.crm.dynamics.com/;")) { 
  conn.Open();
  adapter.UpdateCommand = conn.CreateCommand();
  adapter.UpdateCommand.CommandText = "UPDATE Accounts SET Name=@Name WHERE AccountId=@AccountId";
  adapter.UpdateCommand.Parameters.Add("@Name", "Name");
  adapter.UpdateCommand.Parameters.Add("@AccountId", "AccountId");
  adapter.UpdateCommand.UpdatedRowSource = UpdateRowSource.None; 
  adapter.UpdateBatchSize = 2;
  adapter.Update(dataTable);
}

VB.NET

 
Dim adapter As New CDSDataAdapter()

Using conn As New CDSConnection("InitiateOAuth=GETANDREFRESH;OrganizationUrl=https://myaccount.crm.dynamics.com/;")
  conn.Open()
  adapter.UpdateCommand = conn.CreateCommand()
  adapter.UpdateCommand.CommandText = "UPDATE Accounts SET Name=@Name WHERE AccountId=@AccountId"
  adapter.UpdateCommand.Parameters.Add("@Name", "Name")
  adapter.UpdateCommand.Parameters.Add("@AccountId", "AccountId")
  adapter.UpdateCommand.UpdatedRowSource = UpdateRowSource.None
  adapter.UpdateBatchSize = 2
  adapter.Update(dataTable)
End Using

Bulk Delete

The following code prepares a single batch that deletes records in bulk. The primary key for each row is required. The following example executes a batch for all DataRow records with a "Deleted" state:

C#

CDSDataAdapter adapter = new CDSDataAdapter();

using (CDSConnection conn = new CDSConnection("InitiateOAuth=GETANDREFRESH;OrganizationUrl=https://myaccount.crm.dynamics.com/;")) {
  conn.Open();
  adapter.DeleteCommand = conn.CreateCommand();
  adapter.DeleteCommand.CommandText = "DELETE FROM Accounts WHERE AccountId=@AccountId";
  adapter.DeleteCommand.Parameters.Add("@AccountId", "AccountId");
  adapter.DeleteCommand.UpdatedRowSource = UpdateRowSource.None; 
  adapter.UpdateBatchSize = 2;
  adpater.Update(table);
}

VB.NET

Dim adapter As New CDSDataAdapter()

Using conn As New CDSConnection("InitiateOAuth=GETANDREFRESH;OrganizationUrl=https://myaccount.crm.dynamics.com/;")
  conn.Open()
  adapter.DeleteCommand = conn.CreateCommand()
  adapter.DeleteCommand.CommandText = "DELETE FROM Accounts WHERE AccountId=@AccountId"
  adapter.DeleteCommand.Parameters.Add("@AccountId", "AccountId")
  adapter.DeleteCommand.UpdatedRowSource = UpdateRowSource.None 
  adapter.UpdateBatchSize = 2
  adpater.Update(table)
End Using

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839