ADO.NET Provider for Google Sheets

Build 24.0.9060

Batch Processing

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

GoogleSheetsDataAdapter adapter = new GoogleSheetsDataAdapter();

using (GoogleSheetsConnection conn = new GoogleSheetsConnection("InitiateOAuth=GETANDREFRESH;Spreadsheet=NorthwindOrders")) {
  conn.Open();
  adapter.InsertCommand = conn.CreateCommand();
  adapter.InsertCommand.CommandText = "INSERT INTO Spreadsheet1_Sheet1 (Column1) VALUES (@Column1)";
  adapter.InsertCommand.UpdatedRowSource = UpdateRowSource.None;
  adapter.InsertCommand.Parameters.Add("@Column1", "Column1");

  DataTable batchDataTable = new DataTable();
  batchDataTable.Columns.Add("Column1", typeof(string));
  batchDataTable.Rows.Add("Jon Doe");
  batchDataTable.Rows.Add("John");
  adapter.UpdateBatchSize = 2;
  adapter.Update(batchDataTable);

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

Using conn As New GoogleSheetsConnection("InitiateOAuth=GETANDREFRESH;Spreadsheet=NorthwindOrders")
  conn.Open()
  adapter.InsertCommand = conn.CreateCommand()
  adapter.InsertCommand.CommandText = "INSERT INTO Spreadsheet1_Sheet1 (Id) VALUES (@Column1)"
  adapter.InsertCommand.UpdatedRowSource = UpdateRowSource.None
  adapter.InsertCommand.Parameters.Add("@Column1", "Column1")

  Dim batchDataTable As New DataTable()
  batchDataTable.Columns.Add("Column1", GetType(String))
  batchDataTable.Rows.Add("John")
  batchDataTable.Rows.Add("Jon Doe")
  adapter.UpdateBatchSize = 2
  adapter.Update(batchDataTable)

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

GoogleSheetsDataAdapter adapter = new GoogleSheetsDataAdapter();

using (GoogleSheetsConnection conn = new GoogleSheetsConnection("InitiateOAuth=GETANDREFRESH;Spreadsheet=NorthwindOrders")) { 
  conn.Open();
  adapter.UpdateCommand = conn.CreateCommand();
  adapter.UpdateCommand.CommandText = "UPDATE Spreadsheet1_Sheet1 SET Column1=@Column1 WHERE Id=@Id";
  adapter.UpdateCommand.Parameters.Add("@Column1", "Column1");
  adapter.UpdateCommand.Parameters.Add("@Id", "Id");
  adapter.UpdateCommand.UpdatedRowSource = UpdateRowSource.None; 
  DataTable batchDataTable = new DataTable();
  batchDataTable.Columns.Add("Column1", typeof(string));
  batchDataTable.Rows.Add("Jon Doe");
  batchDataTable.Rows.Add("John");
  adapter.UpdateBatchSize = 2;
  adapter.Update(dataTable);
}

VB.NET

 
Dim adapter As New GoogleSheetsDataAdapter()

Using conn As New GoogleSheetsConnection("InitiateOAuth=GETANDREFRESH;Spreadsheet=NorthwindOrders")
  conn.Open()
  adapter.UpdateCommand = conn.CreateCommand()
  adapter.UpdateCommand.CommandText = "UPDATE Spreadsheet1_Sheet1 SET Column1=@Column1 WHERE Id=@Id"
  adapter.UpdateCommand.Parameters.Add("@Column1", "Column1")
  adapter.UpdateCommand.Parameters.Add("@Id", "Id")
  adapter.UpdateCommand.UpdatedRowSource = UpdateRowSource.None
  Dim batchDataTable As New DataTable()
  batchDataTable.Columns.Add("Column1", 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#

GoogleSheetsDataAdapter adapter = new GoogleSheetsDataAdapter();

using (GoogleSheetsConnection conn = new GoogleSheetsConnection("InitiateOAuth=GETANDREFRESH;Spreadsheet=NorthwindOrders")) {
  conn.Open();
  adapter.DeleteCommand = conn.CreateCommand();
  adapter.DeleteCommand.CommandText = "DELETE FROM Spreadsheet1_Sheet1 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 GoogleSheetsDataAdapter()

Using conn As New GoogleSheetsConnection("InitiateOAuth=GETANDREFRESH;Spreadsheet=NorthwindOrders")
  conn.Open()
  adapter.DeleteCommand = conn.CreateCommand()
  adapter.DeleteCommand.CommandText = "DELETE FROM Spreadsheet1_Sheet1 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