バッチ処理

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

ADO.NET Batch API の使用

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

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

バッチサイズの制御

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

一括INSERT

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

SmartsheetDataAdapter adapter = new SmartsheetDataAdapter();

using (SmartsheetConnection conn = new SmartsheetConnection("InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;")) {
  conn.Open();
  adapter.InsertCommand = conn.CreateCommand();
  adapter.InsertCommand.CommandText = "INSERT INTO Sheet_Test_Sheet (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("Basic Project with Resource Management");
  batchDataTable.Rows.Add("Basic Agile Project with Gantt Timeline");
  adapter.UpdateBatchSize = 2;
  adapter.Update(batchDataTable);
}

VB.NET

 
Dim adapter As New SmartsheetDataAdapter()

Using conn As New SmartsheetConnection("InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;")
  conn.Open()
  adapter.InsertCommand = conn.CreateCommand()
  adapter.InsertCommand.CommandText = "INSERT INTO Sheet_Test_Sheet (Id) 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("Basic Agile Project with Gantt Timeline")
  batchDataTable.Rows.Add("Basic Project with Resource Management")
  adapter.UpdateBatchSize = 2
  adapter.Update(batchDataTable)
End Using

一括更新

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

SmartsheetDataAdapter adapter = new SmartsheetDataAdapter();

using (SmartsheetConnection conn = new SmartsheetConnection("InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;")) { 
  conn.Open();
  adapter.UpdateCommand = conn.CreateCommand();
  adapter.UpdateCommand.CommandText = "UPDATE Sheet_Test_Sheet SET Name=@Name WHERE Id=@Id";
  adapter.UpdateCommand.Parameters.Add("@Name", "Name");
  adapter.UpdateCommand.Parameters.Add("@Id", "Id");
  adapter.UpdateCommand.UpdatedRowSource = UpdateRowSource.None; 
  DataTable batchDataTable = new DataTable();
  batchDataTable.Columns.Add("Name", typeof(string));
  batchDataTable.Rows.Add("Basic Project with Resource Management");
  batchDataTable.Rows.Add("Basic Agile Project with Gantt Timeline");
  adapter.UpdateBatchSize = 2;
  adapter.Update(dataTable);
}

VB.NET

 
Dim adapter As New SmartsheetDataAdapter()

Using conn As New SmartsheetConnection("InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;")
  conn.Open()
  adapter.UpdateCommand = conn.CreateCommand()
  adapter.UpdateCommand.CommandText = "UPDATE Sheet_Test_Sheet SET Name=@Name WHERE Id=@Id"
  adapter.UpdateCommand.Parameters.Add("@Name", "Name")
  adapter.UpdateCommand.Parameters.Add("@Id", "Id")
  adapter.UpdateCommand.UpdatedRowSource = UpdateRowSource.None
  Dim batchDataTable As New DataTable()
  batchDataTable.Columns.Add("Name", GetType(String))
  batchDataTable.Rows.Add("Basic Agile Project with Gantt Timeline")
  batchDataTable.Rows.Add("Basic Project with Resource Management")
  adapter.UpdateBatchSize = 2
  adapter.Update(dataTable)
End Using

一括削除

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

SmartsheetDataAdapter adapter = new SmartsheetDataAdapter();

using (SmartsheetConnection conn = new SmartsheetConnection("InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;")) {
  conn.Open();
  adapter.DeleteCommand = conn.CreateCommand();
  adapter.DeleteCommand.CommandText = "DELETE FROM Sheet_Test_Sheet 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 SmartsheetDataAdapter()

Using conn As New SmartsheetConnection("InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;")
  conn.Open()
  adapter.DeleteCommand = conn.CreateCommand()
  adapter.DeleteCommand.CommandText = "DELETE FROM Sheet_Test_Sheet WHERE Id=@Id"
  adapter.DeleteCommand.Parameters.Add("@Id", "Id")
  adapter.DeleteCommand.UpdatedRowSource = UpdateRowSource.None 
  adapter.UpdateBatchSize = 2
  adpater.Update(table)
End Using