Getting Started with EFCore
Install Entity Framework Core
Install and configure the Entity Framework Core environment. Use the Package Manager Console in Visual Studio to install the appropriate version of EF Core.
The following versions are supported through bundled assemblies.
- 3.1
- 6.0
To download and install EF Core automatically, first run one of the following commands:
Install-Package Microsoft.EntityFrameworkCore -Version 3.1 //Run this command if using EF Core 3.1 Install-Package Microsoft.EntityFrameworkCore -Version 6.0 //Run this command if using EF Core 6.0
Additionally, you'll need to install EF Core's Relational assembly, as shown in the following example::
Install-Package Microsoft.EntityFrameworkCore.Relational -Version 3.1 //Run this command if using EF Core 3.1 Install-Package Microsoft.EntityFrameworkCore.Relational -Version 6.0 //Run this command if using EF Core 6.0
If you need access to code pages beyond those bundled with .NET Standard, install the following package:
Install-Package System.Text.Encoding.CodePages
Register the Entity Framework Core Provider
Complete the following steps to register the Entity Framework Core provider:
- Add a reference to System.Data.CData.Microsoft SharePoint Excel.dll, located in the lib -> netstandard2.0 subfolder in the installation directory.
- Add a reference to CData.EntityFrameworkCore.Microsoft SharePoint Excel.dll:
- For EF Core 6.0, this is located in the lib -> net6.0 -> EFCORE60 subfolder in the installation directory.
- For EF Core 3.1, this is located in the lib -> netstandard2.0 -> EFCORE31 subfolder in the installation directory.
- Add the included licensing file (.lic) to your project. You can accomplish this by right-clicking the project in the Solution Explorer, then navigating to Add -> Existing Item -> System.Data.CData.Microsoft SharePoint Excel.lic (located in the lib -> netstandard2.0 subfolder in your installation directory). Finally, right-click the licensing file, and set Copy to Output Directory to Copy if newer.
- Build the project to complete the setup for using EF Core.
Creating the Data Model
There are two approaches that can be taken in creating the context and entity classes for your application. With the Code-First Approach approach, you can fine-tune your model by writing the classes manually. Alternatively, you can make use of Reverse Engineering (Scaffolding) to generate these classes automatically from your Excel Services schema.