ADO.NET Provider for Xero

Build 24.0.9060

Batch Processing

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

XeroDataAdapter adapter = new XeroDataAdapter();

using (XeroConnection conn = new XeroConnection("InitiateOAuth=GETANDREFRESH;")) {
  conn.Open();
  adapter.InsertCommand = conn.CreateCommand();
  adapter.InsertCommand.CommandText = "INSERT INTO Contacts (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("John Doe");
  batchDataTable.Rows.Add("John Doe");
  adapter.UpdateBatchSize = 2;
  adapter.Update(batchDataTable);

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

Using conn As New XeroConnection("InitiateOAuth=GETANDREFRESH;")
  conn.Open()
  adapter.InsertCommand = conn.CreateCommand()
  adapter.InsertCommand.CommandText = "INSERT INTO Contacts (Discount) 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 Doe")
  batchDataTable.Rows.Add("John Doe")
  adapter.UpdateBatchSize = 2
  adapter.Update(batchDataTable)

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

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