Ready to get started?

Learn more about the CData ADO.NET Provider for HPCC or download a free trial:

Download Now

Access HPCC Systems Data with Entity Framework 6

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

    To connect, set the following connection properties: Set URL to the machine name or IP address of the server and the port the server is running on, for example, https://server:port. The User and Password are required to authenticate to the HPCC Systems cluster specified in the URL. Note that LDAP authentication is not currently supported by our ODBC driver.

    Set Version to the WsSQL Web server version. Note that if you have not already done so, you will need to install the WsSQL service on the HPCC Systems server. The WsSQL Web service is used to interact with the underlying HPCC Systems platform.

    Set Cluster to the target cluster.

    <configuration> ... <connectionStrings> <add name="HPCCContext" connectionString="Offline=False;URL=http://127.0.0.1:8510;User=test;password=xA123456;Version=1;Cluster=hthor;" providerName="System.Data.CData.HPCC" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.HPCC" type="System.Data.CData.HPCC.HPCCProviderServices, System.Data.CData.HPCC.Entities.EF6" /> </providers> <entityFramework> </configuration> </code>
  4. Add a reference to System.Data.CData.HPCC.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 HPCCContext. 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 HPCCContext : DbContext { public HPCCContext() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<HPCCContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } }
  7. Create another .cs file and name it after the HPCC Systems entity you are retrieving, for example, hpcc::test::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("hpcc::test::orders")] public class hpcc::test::orders { [System.ComponentModel.DataAnnotations.Key] public System.String CustomerName { get; set; } public System.String Price { get; set; } }
  8. Now that you have created an entity, add the entity to your context class: public DbSet<hpcc::test::orders> hpcc::test::orders { set; get; }
  9. With the context and entity finished, you are now ready to query the data in a separate class. For example: HPCCContext context = new HPCCContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.hpcc::test::orders select line;