Batch Processing
The CData ADO.NET Provider for QuickBooks Time enables you to take advantage of the bulk load support in QuickBooks Time through QuickBooksTimeDataAdapters. 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:
- Define custom parameterized SQL statements in QuickBooksTimeCommand objects.
- Set the UpdatedRowSource property of the QuickBooksTimeCommand object to "UpdateRowSource.None".
- Assign the QuickBooksTimeCommand objects to the QuickBooksTimeDataAdapter.
- Add the parameters to the command.
- Call the QuickBooksTimeDataAdapter'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 QuickBooksTimeDataAdapter's UpdateBatchSize property to a positive integer.
Bulk INSERT
The following code prepares a single batch that inserts records in bulk. The example executes a batch INSERT of new DataRows, which have the "Added" state.
C#
QuickBooksTimeDataAdapter adapter = new QuickBooksTimeDataAdapter();
using (QuickBooksTimeConnection conn = new QuickBooksTimeConnection("OAuthClientId=myclientid;OAuthClientSecret=myclientsecret;InitiateOAuth=GETANDREFRESH;CallbackUrl=http://localhost:33333;")) {
conn.Open();
adapter.InsertCommand = conn.CreateCommand();
adapter.InsertCommand.CommandText = "INSERT INTO Timesheets (JobcodeId) VALUES (@JobcodeId)";
adapter.InsertCommand.UpdatedRowSource = UpdateRowSource.None;
adapter.InsertCommand.Parameters.Add("@JobcodeId", "JobcodeId");
DataTable batchDataTable = new DataTable();
batchDataTable.Columns.Add("JobcodeId", typeof(string));
batchDataTable.Rows.Add("Jon Doe");
batchDataTable.Rows.Add("John");
adapter.UpdateBatchSize = 2;
adapter.Update(batchDataTable);
}
VB.NET
Dim adapter As New QuickBooksTimeDataAdapter()
Using conn As New QuickBooksTimeConnection("OAuthClientId=myclientid;OAuthClientSecret=myclientsecret;InitiateOAuth=GETANDREFRESH;CallbackUrl=http://localhost:33333;")
conn.Open()
adapter.InsertCommand = conn.CreateCommand()
adapter.InsertCommand.CommandText = "INSERT INTO Timesheets (Id) VALUES (@JobcodeId)"
adapter.InsertCommand.UpdatedRowSource = UpdateRowSource.None
adapter.InsertCommand.Parameters.Add("@JobcodeId", "JobcodeId")
Dim batchDataTable As New DataTable()
batchDataTable.Columns.Add("JobcodeId", GetType(String))
batchDataTable.Rows.Add("John")
batchDataTable.Rows.Add("Jon Doe")
adapter.UpdateBatchSize = 2
adapter.Update(batchDataTable)
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#
QuickBooksTimeDataAdapter adapter = new QuickBooksTimeDataAdapter();
using (QuickBooksTimeConnection conn = new QuickBooksTimeConnection("OAuthClientId=myclientid;OAuthClientSecret=myclientsecret;InitiateOAuth=GETANDREFRESH;CallbackUrl=http://localhost:33333;")) {
conn.Open();
adapter.UpdateCommand = conn.CreateCommand();
adapter.UpdateCommand.CommandText = "UPDATE Timesheets SET JobcodeId=@JobcodeId WHERE Id=@Id";
adapter.UpdateCommand.Parameters.Add("@JobcodeId", "JobcodeId");
adapter.UpdateCommand.Parameters.Add("@Id", "Id");
adapter.UpdateCommand.UpdatedRowSource = UpdateRowSource.None;
DataTable batchDataTable = new DataTable();
batchDataTable.Columns.Add("JobcodeId", typeof(string));
batchDataTable.Rows.Add("Jon Doe");
batchDataTable.Rows.Add("John");
adapter.UpdateBatchSize = 2;
adapter.Update(dataTable);
}
VB.NET
Dim adapter As New QuickBooksTimeDataAdapter()
Using conn As New QuickBooksTimeConnection("OAuthClientId=myclientid;OAuthClientSecret=myclientsecret;InitiateOAuth=GETANDREFRESH;CallbackUrl=http://localhost:33333;")
conn.Open()
adapter.UpdateCommand = conn.CreateCommand()
adapter.UpdateCommand.CommandText = "UPDATE Timesheets SET JobcodeId=@JobcodeId WHERE Id=@Id"
adapter.UpdateCommand.Parameters.Add("@JobcodeId", "JobcodeId")
adapter.UpdateCommand.Parameters.Add("@Id", "Id")
adapter.UpdateCommand.UpdatedRowSource = UpdateRowSource.None
Dim batchDataTable As New DataTable()
batchDataTable.Columns.Add("JobcodeId", GetType(String))
batchDataTable.Rows.Add("John")
batchDataTable.Rows.Add("Jon Doe")
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#
QuickBooksTimeDataAdapter adapter = new QuickBooksTimeDataAdapter();
using (QuickBooksTimeConnection conn = new QuickBooksTimeConnection("OAuthClientId=myclientid;OAuthClientSecret=myclientsecret;InitiateOAuth=GETANDREFRESH;CallbackUrl=http://localhost:33333;")) {
conn.Open();
adapter.DeleteCommand = conn.CreateCommand();
adapter.DeleteCommand.CommandText = "DELETE FROM Timesheets 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 QuickBooksTimeDataAdapter()
Using conn As New QuickBooksTimeConnection("OAuthClientId=myclientid;OAuthClientSecret=myclientsecret;InitiateOAuth=GETANDREFRESH;CallbackUrl=http://localhost:33333;")
conn.Open()
adapter.DeleteCommand = conn.CreateCommand()
adapter.DeleteCommand.CommandText = "DELETE FROM Timesheets WHERE Id=@Id"
adapter.DeleteCommand.Parameters.Add("@Id", "Id")
adapter.DeleteCommand.UpdatedRowSource = UpdateRowSource.None
adapter.UpdateBatchSize = 2
adpater.Update(table)
End Using