Entity Framework Extensions EF6 - PostgreSQL Provider

PostgreSQL is a general-purpose and object-relational database management system, the most advanced open-source database system.

PostgreSQL has been proven to be highly scalable both in the sheer quantity of data it can manage and in the number of concurrent users it can accommodate.
It allows you to add custom functions developed using different programming languages such as C/C++, Java, etc.
PostgreSQL requires very minimum maintained efforts because of its stability.

Install EFE

Let's create a new application using the Console App (.NET Framework) template and install Z.EntityFramework.Extensions.

Entity Framework Extensions (EFE) library is available as a nuget package and you can install it using Nuget Package Manager.

In the Package Manager Console window, enter the following command.

PM> Install-Package Z.EntityFramework.Extensions

You can also install EFE by right-clicking on your project in Solution Explorer and select Manage Nuget Packages....

Search for Z.EntityFramework.Extensions and install the latest version by pressing the install button.

Register EF Provider

EF providers can be registered using either code-based configuration or in the application's config file. Install the EntityFramework6.Npgsql NuGet package to add this reference automatically within app.config or web.config file during the installation.

PM> Install-Package EntityFramework6.Npgsql

Similarly, you can also install EntityFramework6.Npgsql by right-clicking on your project in Solution Explorer and select Manage Nuget Packages....

Search for EntityFramework6.Npgsql and install the latest version by pressing the install button.

Let's open the App.config file.

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <configSections>
    <section name="entityFramework" type="System.Data.Entity.Internal.ConfigFile.EntityFrameworkSection, EntityFramework, Version=6.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" requirePermission="false" />
    <!-- For more information on Entity Framework configuration, visit https://go.microsoft.com/fwlink/?LinkID=237468 -->
  </configSections>
  <startup>
    <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.7.2" />
  </startup>
  <entityFramework>
    <defaultConnectionFactory type="System.Data.Entity.Infrastructure.SqlConnectionFactory, EntityFramework" />
    <providers>
      <provider invariantName="System.Data.SqlClient" type="System.Data.Entity.SqlServer.SqlProviderServices, EntityFramework.SqlServer" />
      <provider invariantName="Npgsql" type="Npgsql.NpgsqlServices, EntityFramework6.Npgsql" />
    </providers>
  </entityFramework>
  <system.data>
    <DbProviderFactories>
      <remove invariant="Npgsql" />
      <add name="Npgsql Data Provider" invariant="Npgsql" description=".Net Data Provider for PostgreSQL" type="Npgsql.NpgsqlFactory, Npgsql, Culture=neutral, PublicKeyToken=5d8b90d52f46fda7" support="FF" />
    </DbProviderFactories>
  </system.data>
</configuration>

Note that often if the EF provider is installed from NuGet, then the NuGet package will automatically add this registration to the config file.

The invariantName in this registration is the same invariant name used to identify an ADO.NET provider.
The type in this registration is the assembly-qualified name of the provider type that derives from Npgsql.NpgsqlServices.

You are now ready to start your application.

Create Data Model

Model is a collection of classes to interact with the database.

A model stores data that is retrieved according to the commands from the Controller and displayed in the View.
It can also be used to manipulate the data to implement the business logic.

To create a data model for our application, we will start with the following two entities.

public class Author
{
    public int AuthorId { get; set; }
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public DateTime BirthDate { get; set; }
    public List<Book> Books { get; set; }
}

public class Book
{
    public int BookId { get; set; }
    public string Title { get; set; }
    public Author Author { get; set; }
}

There's a one-to-many relationship between Author and Book entities. In other words, an author can write any number of books, and a book can be written by only one author.

Create Database Context

The database context class provides the main functionality to coordinate Entity Framework with a given data model.

You create this class by deriving from the System.Data.Entity.DbContext class.
In your code, you specify which entities are included in the data model.
You can also customize certain Entity Framework behavior.

So, let's add a new BookStore class which will inherit the DbContext class.

public class BookStore : DbContext
{
    public BookStore() : base(nameOrConnectionString: "Default")
    {
    }

    protected override void OnModelCreating(DbModelBuilder modelBuilder)
    {
        modelBuilder.HasDefaultSchema("public");
    }

    public DbSet<Author> Authors { get; set; }
    public DbSet<Book> Books { get; set; }
}

This code creates a DbSet property for each entity set. In Entity Framework terminology, an entity set typically corresponds to a database table, and an entity corresponds to a row in the table.

Setup Database

The name of the connection string is passed into the constructor of the context class.

public BookStore() : base(nameOrConnectionString: "Default")
{
}

If you don't specify a connection string or the name of one explicitly, Entity Framework assumes that the connection string name is the same as the class name.

Connectionn String

Now, we need to configure our PostgreSQL database, so let's open the application App.config file and add a connectionStrings element.

<connectionStrings>
  <add name="Default" connectionString="host=localhost;user id=postgres;password=mw;database=postgres;Pooling=false;Timeout=300;CommandTimeout=300;" providerName="Npgsql" />
</connectionStrings>

The providerName attribute in the connection string definition pointing to the PostgreSQL provider (Npgsql).

Create Database using Migration

Now, to create a database using migrations from your model, run the following command in Package Manager Console.

Add-Migration Initial

This command scaffold a migration to create the initial set of tables for your model. When it is executed successfully, then run the following command.

Update-Database

This command applies the new migration to the database and creates the database before applying migrations.

Now, we are done with the required classes, so let's add some authors and books records to the database and then retrieve it.

using (var context = new BookStore())
{
    var authors = new List<Author>
    {
        new Author
        {
            FirstName ="Carson",
            LastName ="Alexander",
            BirthDate = DateTime.Parse("1985-09-01"),
            Books = new List<Book>()
            {
                new Book { Title = "Introduction to Machine Learning"},
                new Book { Title = "Advanced Topics in Machine Learning"},
                new Book { Title = "Introduction to Computing"}
            }
        },
        new Author
        {
            FirstName ="Meredith",
            LastName ="Alonso",
            BirthDate = DateTime.Parse("1970-09-01"),
            Books = new List<Book>()
            {
                new Book { Title = "Introduction to Microeconomics"}
            }
        },
        new Author
        {
            FirstName ="Arturo",
            LastName ="Anand",
            BirthDate = DateTime.Parse("1963-09-01"),
            Books = new List<Book>()
            {
                new Book { Title = "Calculus I"},
                new Book { Title = "Calculus II"}
            }
        }
    };

    //IncludeGraph allow you to INSERT/UPDATE/MERGE entities by including the child entities graph.
    context.BulkInsert(authors, options => options.IncludeGraph = true );
}

using (var context = new BookStore())
{
    var list = context.Authors
        .Include(a => a.Books)
        .ToList();

    foreach (var author in list)
    {
        Console.WriteLine(author.FirstName + " " + author.LastName);

        foreach (var book in author.Books)
        {
            Console.WriteLine("\t" + book.Title);
        }
    }
}

If you run the application, you will see that authors and books are successfully inserted into the database.

Last updated: 2023-02-27
Author: ZZZ Projects

Install EFE
Register EF Provider
Create Data Model
Create Database Context
Setup Database
- Connectionn String
Create Database using Migration