ADO.NET Provider for Kintone

Build 23.0.8839

Batch Processing

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

KintoneDataAdapter adapter = new KintoneDataAdapter();

using (KintoneConnection conn = new KintoneConnection("User=myuseraccount;Password=mypassword;Url=http://subdomain.domain.com;GuestSpaceId=myspaceid")) {
  conn.Open();
  adapter.InsertCommand = conn.CreateCommand();
  adapter.InsertCommand.CommandText = "INSERT INTO Comments (Text) VALUES (@Text)";
  adapter.InsertCommand.UpdatedRowSource = UpdateRowSource.None;
  adapter.InsertCommand.Parameters.Add("@Text", "Text");

  DataTable batchDataTable = new DataTable();
  batchDataTable.Columns.Add("Text", typeof(string));
  batchDataTable.Rows.Add("Old to do");
  batchDataTable.Rows.Add("New to do");
  adapter.UpdateBatchSize = 2;
  adapter.Update(batchDataTable);

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

Using conn As New KintoneConnection("User=myuseraccount;Password=mypassword;Url=http://subdomain.domain.com;GuestSpaceId=myspaceid")
  conn.Open()
  adapter.InsertCommand = conn.CreateCommand()
  adapter.InsertCommand.CommandText = "INSERT INTO Comments (CreatorName) VALUES (@Text)"
  adapter.InsertCommand.UpdatedRowSource = UpdateRowSource.None
  adapter.InsertCommand.Parameters.Add("@Text", "Text")

  Dim batchDataTable As New DataTable()
  batchDataTable.Columns.Add("Text", GetType(String))
  batchDataTable.Rows.Add("New to do")
  batchDataTable.Rows.Add("Old to do")
  adapter.UpdateBatchSize = 2
  adapter.Update(batchDataTable)

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

KintoneDataAdapter adapter = new KintoneDataAdapter();

using (KintoneConnection conn = new KintoneConnection("User=myuseraccount;Password=mypassword;Url=http://subdomain.domain.com;GuestSpaceId=myspaceid")) { 
  conn.Open();
  adapter.UpdateCommand = conn.CreateCommand();
  adapter.UpdateCommand.CommandText = "UPDATE Comments SET Text=@Text WHERE Id=@Id";
  adapter.UpdateCommand.Parameters.Add("@Text", "Text");
  adapter.UpdateCommand.Parameters.Add("@Id", "Id");
  adapter.UpdateCommand.UpdatedRowSource = UpdateRowSource.None; 
  adapter.UpdateBatchSize = 2;
  adapter.Update(dataTable);
}

VB.NET

 
Dim adapter As New KintoneDataAdapter()

Using conn As New KintoneConnection("User=myuseraccount;Password=mypassword;Url=http://subdomain.domain.com;GuestSpaceId=myspaceid")
  conn.Open()
  adapter.UpdateCommand = conn.CreateCommand()
  adapter.UpdateCommand.CommandText = "UPDATE Comments SET Text=@Text WHERE Id=@Id"
  adapter.UpdateCommand.Parameters.Add("@Text", "Text")
  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#

KintoneDataAdapter adapter = new KintoneDataAdapter();

using (KintoneConnection conn = new KintoneConnection("User=myuseraccount;Password=mypassword;Url=http://subdomain.domain.com;GuestSpaceId=myspaceid")) {
  conn.Open();
  adapter.DeleteCommand = conn.CreateCommand();
  adapter.DeleteCommand.CommandText = "DELETE FROM Comments 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 KintoneDataAdapter()

Using conn As New KintoneConnection("User=myuseraccount;Password=mypassword;Url=http://subdomain.domain.com;GuestSpaceId=myspaceid")
  conn.Open()
  adapter.DeleteCommand = conn.CreateCommand()
  adapter.DeleteCommand.CommandText = "DELETE FROM Comments 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