ADO.NET Provider for Azure Cosmos DB

Build 24.0.9060

Batch Processing

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

CosmosDBDataAdapter adapter = new CosmosDBDataAdapter();

using (CosmosDBConnection conn = new CosmosDBConnection("AccountEndpoint=myAccountEndpoint;AccountKey=myAccountKey;")) {
  conn.Open();
  adapter.InsertCommand = conn.CreateCommand();
  adapter.InsertCommand.CommandText = "INSERT INTO [CData].[Entities].Customers (CompanyName) VALUES (@CompanyName)";
  adapter.InsertCommand.UpdatedRowSource = UpdateRowSource.None;
  adapter.InsertCommand.Parameters.Add("@CompanyName", "CompanyName");

  DataTable batchDataTable = new DataTable();
  batchDataTable.Columns.Add("CompanyName", typeof(string));
  batchDataTable.Rows.Add("Jon Deere");
  batchDataTable.Rows.Add("Caterpillar");
  adapter.UpdateBatchSize = 2;
  adapter.Update(batchDataTable);
}

VB.NET

 
Dim adapter As New CosmosDBDataAdapter()

Using conn As New CosmosDBConnection("AccountEndpoint=myAccountEndpoint;AccountKey=myAccountKey;")
  conn.Open()
  adapter.InsertCommand = conn.CreateCommand()
  adapter.InsertCommand.CommandText = "INSERT INTO [CData].[Entities].Customers (City) VALUES (@CompanyName)"
  adapter.InsertCommand.UpdatedRowSource = UpdateRowSource.None
  adapter.InsertCommand.Parameters.Add("@CompanyName", "CompanyName")

  Dim batchDataTable As New DataTable()
  batchDataTable.Columns.Add("CompanyName", GetType(String))
  batchDataTable.Rows.Add("Caterpillar")
  batchDataTable.Rows.Add("Jon Deere")
  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#

CosmosDBDataAdapter adapter = new CosmosDBDataAdapter();

using (CosmosDBConnection conn = new CosmosDBConnection("AccountEndpoint=myAccountEndpoint;AccountKey=myAccountKey;")) { 
  conn.Open();
  adapter.UpdateCommand = conn.CreateCommand();
  adapter.UpdateCommand.CommandText = "UPDATE [CData].[Entities].Customers SET CompanyName=@CompanyName WHERE _id=@_id";
  adapter.UpdateCommand.Parameters.Add("@CompanyName", "CompanyName");
  adapter.UpdateCommand.Parameters.Add("@_id", "_id");
  adapter.UpdateCommand.UpdatedRowSource = UpdateRowSource.None; 
  DataTable batchDataTable = new DataTable();
  batchDataTable.Columns.Add("CompanyName", typeof(string));
  batchDataTable.Rows.Add("Jon Deere");
  batchDataTable.Rows.Add("Caterpillar");
  adapter.UpdateBatchSize = 2;
  adapter.Update(dataTable);
}

VB.NET

 
Dim adapter As New CosmosDBDataAdapter()

Using conn As New CosmosDBConnection("AccountEndpoint=myAccountEndpoint;AccountKey=myAccountKey;")
  conn.Open()
  adapter.UpdateCommand = conn.CreateCommand()
  adapter.UpdateCommand.CommandText = "UPDATE [CData].[Entities].Customers SET CompanyName=@CompanyName WHERE _id=@_id"
  adapter.UpdateCommand.Parameters.Add("@CompanyName", "CompanyName")
  adapter.UpdateCommand.Parameters.Add("@_id", "_id")
  adapter.UpdateCommand.UpdatedRowSource = UpdateRowSource.None
  Dim batchDataTable As New DataTable()
  batchDataTable.Columns.Add("CompanyName", GetType(String))
  batchDataTable.Rows.Add("Caterpillar")
  batchDataTable.Rows.Add("Jon Deere")
  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#

CosmosDBDataAdapter adapter = new CosmosDBDataAdapter();

using (CosmosDBConnection conn = new CosmosDBConnection("AccountEndpoint=myAccountEndpoint;AccountKey=myAccountKey;")) {
  conn.Open();
  adapter.DeleteCommand = conn.CreateCommand();
  adapter.DeleteCommand.CommandText = "DELETE FROM [CData].[Entities].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 CosmosDBDataAdapter()

Using conn As New CosmosDBConnection("AccountEndpoint=myAccountEndpoint;AccountKey=myAccountKey;")
  conn.Open()
  adapter.DeleteCommand = conn.CreateCommand()
  adapter.DeleteCommand.CommandText = "DELETE FROM [CData].[Entities].Customers 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 24.0.9060