ADO.NET Provider for Microsoft SharePoint Excel

Build 23.0.8839

Querying with the DataAdapter

The CData ADO.NET Provider for Microsoft SharePoint Excel implements two ADO.NET interfaces you can use to retrieve data from Excel Services: Microsoft SharePoint ExcelDataAdapter and Microsoft SharePoint ExcelDataReader objects. Whereas Microsoft SharePoint ExcelDataAdapter objects retrieve a single result set of all the data that matches a query, Microsoft SharePoint ExcelDataReader objects fetch data in subset increments as needed.

Using the Microsoft SharePoint ExcelDataAdapter

Use the adapter's Fill method to retrieve data from the data source. An empty DataTable instance is passed as an argument to the Fill method. When the method returns, the DataTable instance is populated with the queried data. Note that the Microsoft SharePoint ExcelDataAdapter is slower than the Microsoft SharePoint ExcelDataReader because the Fill method needs to retrieve all data from the data source before returning.

The following example selects the Id and Name columns of the Account table:

C#

string connectionString = "Url=https://myorg.sharepoint.com;User=admin@myorg.onmicrosoft.com;Password=password;File=Book1.xlsx;";

using (Microsoft SharePoint ExcelConnection connection = new Microsoft SharePoint ExcelConnection(connectionString)) {
  Microsoft SharePoint ExcelDataAdapter dataAdapter = new Microsoft SharePoint ExcelDataAdapter(
  "SELECT Id, Name FROM Account", connection);

  DataTable table = new DataTable();
  dataAdapter.Fill(table);

  Console.WriteLine("Contents of Account.");

  foreach (DataRow row in table.Rows) {
    Console.WriteLine("{0}: {1}", row["Id"], row["Name"]);
  }
}

VB.NET

Dim connectionString As String = "Url=https://myorg.sharepoint.com;User=admin@myorg.onmicrosoft.com;Password=password;File=Book1.xlsx;"

Using connection As New Microsoft SharePoint ExcelConnection(connectionString)
  Dim dataAdapter As New Microsoft SharePoint ExcelDataAdapter("SELECT Id, Name FROM Account", connection)

  Dim table As New DataTable()
  dataAdapter.Fill(table)

  Console.WriteLine("Contents of Account.")

  For Each row As DataRow In table.Rows
    Console.WriteLine("{0}: {1}", row("Id"), row("Name"))
  Next
End Using

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839