Access EnterpriseDB Data with Entity Framework 6

Ready to get started?

Download for a free trial:

Download Now

Learn more:

EnterpriseDB ADO.NET Provider

Rapidly create and deploy powerful .NET applications that integrate with EnterpriseDB.



This article shows how to access EnterpriseDB 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 EnterpriseDB 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 EnterpriseDB Entity Framework 6 assembly and the connection string.

    The following connection properties are required in order to connect to data.

    • Server: The host name or IP of the server hosting the EnterpriseDB database.
    • Port: The port of the server hosting the EnterpriseDB database.

    You can also optionally set the following:

    • Database: The default database to connect to when connecting to the EnterpriseDB Server. If this is not set, the user's default database will be used.

    Connect Using Standard Authentication

    To authenticate using standard authentication, set the following:

    • User: The user which will be used to authenticate with the EnterpriseDB server.
    • Password: The password which will be used to authenticate with the EnterpriseDB server.

    Connect Using SSL Authentication

    You can leverage SSL authentication to connect to EnterpriseDB data via a secure session. Configure the following connection properties to connect to data:

    • SSLClientCert: Set this to the name of the certificate store for the client certificate. Used in the case of 2-way SSL, where truststore and keystore are kept on both the client and server machines.
    • SSLClientCertPassword: If a client certificate store is password-protected, set this value to the store's password.
    • SSLClientCertSubject: The subject of the TLS/SSL client certificate. Used to locate the certificate in the store.
    • SSLClientCertType: The certificate type of the client store.
    • SSLServerCert: The certificate to be accepted from the server.
    <configuration> ... <connectionStrings> <add name="EnterpriseDBContext" connectionString="Offline=False;User=postgres;Password=admin;Database=postgres;Server=127.0.0.1;Port=5444" providerName="System.Data.CData.EnterpriseDB" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.EnterpriseDB" type="System.Data.CData.EnterpriseDB.EnterpriseDBProviderServices, System.Data.CData.EnterpriseDB.Entities.EF6" /> </providers> <entityFramework> </configuration> </code>
  4. Add a reference to System.Data.CData.EnterpriseDB.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 EnterpriseDBContext. 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 EnterpriseDBContext : DbContext { public EnterpriseDBContext() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<EnterpriseDBContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } }
  7. Create another .cs file and name it after the EnterpriseDB 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: EnterpriseDBContext context = new EnterpriseDBContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.Orders select line;