バッチ処理

CData ADO.NET Provider for QuickBooks Online では、QuickBooksOnlineDataAdapters を通じて、QuickBooks Online の一括ロードサポートを活用することができます。Batch API を使用して、関連するSQL データ操作ステートメントを同時に実行できます。本製品はバッチ内のすべてのSQL クエリを単一のリクエストに変換します。

ADO.NET Batch API の使用

バッチ更新を実行するには、次の基本的な手順を実行します。

QuickBooksOnlineCommand オブジェクトで、パラメータ化されたカスタムSQL ステートメントを定義します。
QuickBooksOnlineCommand オブジェクトのUpdatedRowSource プロパティを"UpdateRowSource.None" に設定します。
QuickBooksOnlineCommand オブジェクトをQuickBooksOnlineDataAdapter に割り当てます。
パラメータをコマンドに追加します。
QuickBooksOnlineDataAdapter のUpdate メソッドを呼び出します。変更を含むDataSet またはDataTable を渡します。

バッチサイズの制御

要求のサイズ、ネットワークリソース、サーバーのパフォーマンスなどの要因に応じて、より小さなバッチ要求をいくつか実行することでパフォーマンスを向上させることができます。各バッチのサイズは、QuickBooksOnlineDataAdapter のUpdateBatchSize プロパティを正の整数に設定することで制御できます。

一括挿入

次のコードはレコードを一括で挿入する単一のバッチを準備します。そして、新しいレコードのId を取得します。この例では、"Added" 状態の新しいDataRows の一括挿入を実行します。

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

一括更新

バッチ更新では、さらに、更新する各行の主キーが必要です。次の例では、"Modified" 状態のすべてのDataRow レコードに対してバッチを実行します。

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

一括削除

次のコードは、レコードを一括で削除する単一のバッチを準備します。各行の主キーが必要です。次の例では、"Deleted" 状態のすべてのDataRow レコードに対してバッチを実行します。

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