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

SharePointDataAdapter adapter = new SharePointDataAdapter();

using (SharePointConnection conn = new SharePointConnection("User=MyUserAccount;Password=MyPassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;")) {
  conn.Open();
  adapter.InsertCommand = conn.CreateCommand();
  adapter.InsertCommand.CommandText = "INSERT INTO Calendar (Location) VALUES (@Location)";
  adapter.InsertCommand.UpdatedRowSource = UpdateRowSource.None;
  adapter.InsertCommand.Parameters.Add("@Location", "Location");

  DataTable batchDataTable = new DataTable();
  batchDataTable.Columns.Add("Location", typeof(string));
  batchDataTable.Rows.Add("France");
  batchDataTable.Rows.Add("U.S.A.");
  adapter.UpdateBatchSize = 2;
  adapter.Update(batchDataTable);

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

Using conn As New SharePointConnection("User=MyUserAccount;Password=MyPassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;")
  conn.Open()
  adapter.InsertCommand = conn.CreateCommand()
  adapter.InsertCommand.CommandText = "INSERT INTO Calendar (Id) VALUES (@Location)"
  adapter.InsertCommand.UpdatedRowSource = UpdateRowSource.None
  adapter.InsertCommand.Parameters.Add("@Location", "Location")

  Dim batchDataTable As New DataTable()
  batchDataTable.Columns.Add("Location", GetType(String))
  batchDataTable.Rows.Add("U.S.A.")
  batchDataTable.Rows.Add("France")
  adapter.UpdateBatchSize = 2
  adapter.Update(batchDataTable)

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

SharePointDataAdapter adapter = new SharePointDataAdapter();

using (SharePointConnection conn = new SharePointConnection("User=MyUserAccount;Password=MyPassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;")) { 
  conn.Open();
  adapter.UpdateCommand = conn.CreateCommand();
  adapter.UpdateCommand.CommandText = "UPDATE Calendar SET Location=@Location WHERE Id=@Id";
  adapter.UpdateCommand.Parameters.Add("@Location", "Location");
  adapter.UpdateCommand.Parameters.Add("@Id", "Id");
  adapter.UpdateCommand.UpdatedRowSource = UpdateRowSource.None; 
  adapter.UpdateBatchSize = 2;
  adapter.Update(dataTable);
}

VB.NET

 
Dim adapter As New SharePointDataAdapter()

Using conn As New SharePointConnection("User=MyUserAccount;Password=MyPassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;")
  conn.Open()
  adapter.UpdateCommand = conn.CreateCommand()
  adapter.UpdateCommand.CommandText = "UPDATE Calendar SET Location=@Location WHERE Id=@Id"
  adapter.UpdateCommand.Parameters.Add("@Location", "Location")
  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#

SharePointDataAdapter adapter = new SharePointDataAdapter();

using (SharePointConnection conn = new SharePointConnection("User=MyUserAccount;Password=MyPassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;")) {
  conn.Open();
  adapter.DeleteCommand = conn.CreateCommand();
  adapter.DeleteCommand.CommandText = "DELETE FROM Calendar 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 SharePointDataAdapter()

Using conn As New SharePointConnection("User=MyUserAccount;Password=MyPassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;")
  conn.Open()
  adapter.DeleteCommand = conn.CreateCommand()
  adapter.DeleteCommand.CommandText = "DELETE FROM Calendar WHERE Id=@Id"
  adapter.DeleteCommand.Parameters.Add("@Id", "Id")
  adapter.DeleteCommand.UpdatedRowSource = UpdateRowSource.None 
  adapter.UpdateBatchSize = 2
  adpater.Update(table)
End Using