Ends in:
0 DAY
22 HRS
59 MIN
45 SEC
Ends in:
0 D
22 H
59 M
45 S

Switch to EF Core PostgreSQL Provider

ABP CLI and the Get Started page already provides an option to create a new solution with PostgreSQL. See that document to learn how to use. This document provides guidance for who wants to manually switch to PostgreSQL after creating the solution.

This document explains how to switch to the PostgreSQL database provider for the application startup template which comes with SQL Server provider pre-configured.

Replace the Volo.Abp.EntityFrameworkCore.SqlServer Package

.EntityFrameworkCore project in the solution depends on the Volo.Abp.EntityFrameworkCore.SqlServer NuGet package. Remove this package and add the same version of the Volo.Abp.EntityFrameworkCore.PostgreSql package.

Replace the Module Dependency

Find YourProjectNameEntityFrameworkCoreModule class inside the .EntityFrameworkCore project, remove typeof(AbpEntityFrameworkCoreSqlServerModule) from the DependsOn attribute, add typeof(AbpEntityFrameworkCorePostgreSqlModule) (also replace using Volo.Abp.EntityFrameworkCore.SqlServer; with using Volo.Abp.EntityFrameworkCore.PostgreSql;).

UseNpgsql()

Find UseSqlServer() call in YourProjectNameEntityFrameworkCoreModule.cs inside the .EntityFrameworkCore project and replace with UseNpgsql().

Find UseSqlServer() call in YourProjectNameDbContextFactory.cs inside the .EntityFrameworkCore project and replace with UseNpgsql().

Depending on your solution structure, you may find more UseSqlServer() calls that needs to be changed.

Change the Connection Strings

PostgreSql connection strings are different than SQL Server connection strings. So, check all appsettings.json files in your solution and replace the connection strings inside them. See the connectionstrings.com for details of PostgreSql connection string options.

You typically will change the appsettings.json inside the .DbMigrator and .Web projects, but it depends on your solution structure.

Re-Generate the Migrations

The startup template uses Entity Framework Core's Code First Migrations. EF Core Migrations depend on the selected DBMS provider. So, changing the DBMS provider will cause the migration fails.

  • Delete the Migrations folder under the .EntityFrameworkCore project and re-build the solution.
  • Run Add-Migration "Initial" on the Package Manager Console (select the .DbMigrator (or .Web) project as the startup project in the Solution Explorer and select the .EntityFrameworkCore project as the default project in the Package Manager Console).

This will create a database migration with all database objects (tables) configured.

Run the .DbMigrator project to create the database and seed the initial data.

Run the Application

It is ready. Just run the application and enjoy coding.

Contributors


Last updated: July 31, 2024 Edit this page on GitHub

Was this page helpful?

Please make a selection.

To help us improve, please share your reason for the negative feedback in the field below.

Please enter a note.

Thank you for your valuable feedback!

Please note that although we cannot respond to feedback, our team will use your comments to improve the experience.

In this document
Community Talks

What’s New with .NET 9 & ABP 9?

21 Nov, 17:00
Online
Watch the Event
Mastering ABP Framework Book
Mastering ABP Framework

This book will help you gain a complete understanding of the framework and modern web application development techniques.

Learn More