How to Access CockroachDB 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 CockroachDB 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 CockroachDB Entity Framework 6 assembly and the connection string.

   Set the following to connect to CockroachDB.

   • Server: The host name or IP address of the server.
   • Port: The port number of the CockroachDB server. If not specified, the default port is 26257.
   • Database: The name of the Cockroach database. If not specified, you connect to the user's default database.
   • User: The Cockroach DB user account used to authenticate.
   • Password: The password used to authenticate the user.

   <configuration>
    ... 
    <connectionStrings>
    <add name="CockroachDBContext" connectionString="Offline=False;User=root;Password=root;Database=system;Server=localhost;Port=26257" providerName="System.Data.CData.CockroachDB" />
    </connectionStrings>
    <entityFramework>
    <providers>
    ... 
    <provider invariantName="System.Data.CData.CockroachDB" type="System.Data.CData.CockroachDB.CockroachDBProviderServices, System.Data.CData.CockroachDB.Entities.EF6" />
    </providers>
    <entityFramework>
   </configuration>
   </code> 
   

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

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

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

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

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

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