ADO.NET Provider for QuickBooks Online

Build 23.0.8839

Batch Processing

The CData ADO.NET Provider for QuickBooks Online enables you to take advantage of the bulk load support in QuickBooks Online through QuickBooksOnlineDataAdapters. 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 QuickBooksOnlineCommand objects.
  2. Set the UpdatedRowSource property of the QuickBooksOnlineCommand object to "UpdateRowSource.None".
  3. Assign the QuickBooksOnlineCommand objects to the QuickBooksOnlineDataAdapter.
  4. Add the parameters to the command.
  5. Call the QuickBooksOnlineDataAdapter'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 QuickBooksOnlineDataAdapter'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#

QuickBooksOnlineDataAdapter adapter = new QuickBooksOnlineDataAdapter();

using (QuickBooksOnlineConnection conn = new QuickBooksOnlineConnection("InitiateOAuth=GETANDREFRESH;")) {
  conn.Open();
  adapter.InsertCommand = conn.CreateCommand();
  adapter.InsertCommand.CommandText = "INSERT INTO Customers (GivenName) VALUES (@GivenName)";
  adapter.InsertCommand.UpdatedRowSource = UpdateRowSource.None;
  adapter.InsertCommand.Parameters.Add("@GivenName", "GivenName");

  DataTable batchDataTable = new DataTable();
  batchDataTable.Columns.Add("GivenName", typeof(string));
  batchDataTable.Rows.Add("Trujilo, Ana");
  batchDataTable.Rows.Add("Hook, Captain");
  adapter.UpdateBatchSize = 2;
  adapter.Update(batchDataTable);

  QuickBooksOnlineCommand cmd = new QuickBooksOnlineCommand("SELECT * FROM LastResultInfo#TEMP", conn);
  adapter = new QuickBooksOnlineDataAdapter(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 QuickBooksOnlineDataAdapter()

Using conn As New QuickBooksOnlineConnection("InitiateOAuth=GETANDREFRESH;")
  conn.Open()
  adapter.InsertCommand = conn.CreateCommand()
  adapter.InsertCommand.CommandText = "INSERT INTO Customers (Id) VALUES (@GivenName)"
  adapter.InsertCommand.UpdatedRowSource = UpdateRowSource.None
  adapter.InsertCommand.Parameters.Add("@GivenName", "GivenName")

  Dim batchDataTable As New DataTable()
  batchDataTable.Columns.Add("GivenName", GetType(String))
  batchDataTable.Rows.Add("Hook, Captain")
  batchDataTable.Rows.Add("Trujilo, Ana")
  adapter.UpdateBatchSize = 2
  adapter.Update(batchDataTable)

  Dim cmd As New QuickBooksOnlineCommand("SELECT * FROM LastResultInfo#TEMP", conn)
  adapter = New QuickBooksOnlineDataAdapter(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#

QuickBooksOnlineDataAdapter adapter = new QuickBooksOnlineDataAdapter();

using (QuickBooksOnlineConnection conn = new QuickBooksOnlineConnection("InitiateOAuth=GETANDREFRESH;")) { 
  conn.Open();
  adapter.UpdateCommand = conn.CreateCommand();
  adapter.UpdateCommand.CommandText = "UPDATE Customers SET GivenName=@GivenName WHERE Id=@Id";
  adapter.UpdateCommand.Parameters.Add("@GivenName", "GivenName");
  adapter.UpdateCommand.Parameters.Add("@Id", "Id");
  adapter.UpdateCommand.UpdatedRowSource = UpdateRowSource.None; 
  adapter.UpdateBatchSize = 2;
  adapter.Update(dataTable);
}

VB.NET

 
Dim adapter As New QuickBooksOnlineDataAdapter()

Using conn As New QuickBooksOnlineConnection("InitiateOAuth=GETANDREFRESH;")
  conn.Open()
  adapter.UpdateCommand = conn.CreateCommand()
  adapter.UpdateCommand.CommandText = "UPDATE Customers SET GivenName=@GivenName WHERE Id=@Id"
  adapter.UpdateCommand.Parameters.Add("@GivenName", "GivenName")
  adapter.UpdateCommand.Parameters.Add("@Id", "Id")
  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#

QuickBooksOnlineDataAdapter adapter = new QuickBooksOnlineDataAdapter();

using (QuickBooksOnlineConnection conn = new QuickBooksOnlineConnection("InitiateOAuth=GETANDREFRESH;")) {
  conn.Open();
  adapter.DeleteCommand = conn.CreateCommand();
  adapter.DeleteCommand.CommandText = "DELETE FROM Customers WHERE Id=@Id";
  adapter.DeleteCommand.Parameters.Add("@Id", "Id");
  adapter.DeleteCommand.UpdatedRowSource = UpdateRowSource.None; 
  adapter.UpdateBatchSize = 2;
  adpater.Update(table);
}

VB.NET

Dim adapter As New QuickBooksOnlineDataAdapter()

Using conn As New QuickBooksOnlineConnection("InitiateOAuth=GETANDREFRESH;")
  conn.Open()
  adapter.DeleteCommand = conn.CreateCommand()
  adapter.DeleteCommand.CommandText = "DELETE FROM Customers WHERE Id=@Id"
  adapter.DeleteCommand.Parameters.Add("@Id", "Id")
  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