Access SharePoint Data with Entity Framework 6

Ready to get started?

Download for a free trial:

Download Now

Learn more:

SharePoint ADO.NET Provider

Provides .NET developers with the power to easily connect their Web, Desktop, and Mobile applications to data in SharePoint Server Lists, Contacts, Calendar, Links, Tasks, and more!



This article shows how to access SharePoint data using an Entity Framework code-first approach. Entity Framework 6 is available in .NET 4.5 and above.

Entity Framework is an object-relational mapping framework that can be used to work with data as objects. While you can run the ADO.NET Entity Data Model wizard in Visual Studio to handle generating the Entity Model, this approach, the model-first approach, can put you at a disadvantage if there are changes in your data source or if you want more control over how the entities operate. In this article you will complete the code-first approach to accessing SharePoint data using the CData ADO.NET Provider.

  1. Open Visual Studio and create a new Windows Form Application. This article uses a C# project with .NET 4.5.
  2. Run the command 'Install-Package EntityFramework' in the Package Manger Console in Visual Studio to install the latest release of Entity Framework.
  3. Modify the App.config file in the project to add a reference to the SharePoint Entity Framework 6 assembly and the connection string.

    Set the URL property to the base SharePoint site or to a sub-site. This allows you to query any lists and other SharePoint entities defined for the site or sub-site.

    The User and Password properties, under the Authentication section, must be set to valid SharePoint user credentials when using SharePoint On-Premise.

    If you are connecting to SharePoint Online, set the SharePointEdition to SHAREPOINTONLINE along with the User and Password connection string properties. For more details on connecting to SharePoint Online, see the "Getting Started" chapter of the help documentation

    <configuration> ... <connectionStrings> <add name="SharePointContext" connectionString="Offline=False;User=myuseraccount;Password=mypassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;SharePointEdition=SharePointOnPremise;" providerName="System.Data.CData.SharePoint" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.SharePoint" type="System.Data.CData.SharePoint.SharePointProviderServices, System.Data.CData.SharePoint.Entities.EF6" /> </providers> <entityFramework> </configuration> </code>
  4. Add a reference to System.Data.CData.SharePoint.Entities.EF6.dll, located in the lib -> 4.0 subfolder in the installation directory.
  5. Build the project at this point to ensure everything is working correctly. Once that's done, you can start coding using Entity Framework.
  6. Add a new .cs file to the project and add a class to it. This will be your database context, and it will extend the DbContext class. In the example, this class is named SharePointContext. The following code example overrides the OnModelCreating method to make the following changes:
    • Remove PluralizingTableNameConvention from the ModelBuilder Conventions.
    • Remove requests to the MigrationHistory table.
    using System.Data.Entity; using System.Data.Entity.Infrastructure; using System.Data.Entity.ModelConfiguration.Conventions; class SharePointContext : DbContext { public SharePointContext() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<SharePointContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } }
  7. Create another .cs file and name it after the SharePoint entity you are retrieving, for example, MyCustomList. In this file, define both the Entity and the Entity Configuration, which will resemble the example below: using System.Data.Entity.ModelConfiguration; using System.ComponentModel.DataAnnotations.Schema; [System.ComponentModel.DataAnnotations.Schema.Table("MyCustomList")] public class MyCustomList { [System.ComponentModel.DataAnnotations.Key] public System.String Name { get; set; } public System.String Revenue { get; set; } }
  8. Now that you have created an entity, add the entity to your context class: public DbSet<MyCustomList> MyCustomList { set; get; }
  9. With the context and entity finished, you are now ready to query the data in a separate class. For example: SharePointContext context = new SharePointContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.MyCustomList select line;