How to Access Cosmos DB Data Using Entity Framework

Microsoft Entity Framework serves as an object-relational mapping framework for working with data represented as objects. Although Visual Studio offers the ADO.NET Entity Data Model wizard to automatically generate the Entity Model, this model-first approach may present challenges when your data source undergoes changes or when you require greater control over entity operations. In this article, we will delve into the code-first approach for accessing Cosmos DB data through the CData ADO.NET Provider, providing you with more flexibility and control.

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 Cosmos DB Entity Framework 6 assembly and the connection string.

   To obtain the connection string needed to connect to a Cosmos DB account using the SQL API, log in to the Azure Portal, select Azure Cosmos DB, and select your account. In the Settings section, click Connection String and set the following values:

   • AccountEndpoint: The Cosmos DB account URL from the Keys blade of the Cosmos DB account
   • AccountKey: In the Azure portal, navigate to the Cosmos DB service and select your Azure Cosmos DB account. From the resource menu, go to the Keys page. Find the PRIMARY KEY value and set AccountKey to this value.

   <configuration>
    ... 
    <connectionStrings>
    <add name="CosmosDBContext" connectionString="Offline=False;AccountEndpoint=myAccountEndpoint;AccountKey=myAccountKey;" providerName="System.Data.CData.CosmosDB" />
    </connectionStrings>
    <entityFramework>
    <providers>
    ... 
    <provider invariantName="System.Data.CData.CosmosDB" type="System.Data.CData.CosmosDB.CosmosDBProviderServices, System.Data.CData.CosmosDB.Entities.EF6" />
    </providers>
    <entityFramework>
   </configuration>
   </code> 
   

4. Add a reference to System.Data.CData.CosmosDB.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 CosmosDBContext. 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 CosmosDBContext : DbContext {
    public CosmosDBContext() { }
   
    protected override void OnModelCreating(DbModelBuilder modelBuilder)
    {
    // To remove the requests to the Migration History table
    Database.SetInitializer<CosmosDBContext>(null); 
    // To remove the plural names 
    modelBuilder.Conventions.Remove<PluralizingTableNameConvention>();
    } 
   }
   

7. Create another .cs file and name it after the Cosmos DB entity you are retrieving, for example, Customers. 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("Customers")]
   public class Customers {
    [System.ComponentModel.DataAnnotations.Key] 
    public System.String City { get; set; }
    public System.String CompanyName { get; set; }
   }
    
   

8. Now that you have created an entity, add the entity to your context class:

   public DbSet<Customers> Customers { set; get; }
   

9. With the context and entity finished, you are now ready to query the data in a separate class. For example:

   CosmosDBContext context = new CosmosDBContext();
   context.Configuration.UseDatabaseNullSemantics = true;
   var query = from line in context.Customers select line;