Switch to EF Core Oracle Provider

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

Before switching your provider, please ensure your Oracle version is v12.2+. In the earlier versions of Oracle, there were long identifier limitations that prevents creating a database table, column or index longer than 30 bytes. With v12.2 "The maximum length of identifiers is increased to 128 bytes". v12.2 and later versions, you can use the database tables, columns and indexes provided by ABP without any problems.

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.Oracle package.

Replace the Module Dependency

Find YourProjectNameEntityFrameworkCoreModule class inside the .EntityFrameworkCore project, remove typeof(AbpEntityFrameworkCoreSqlServerModule) from the DependsOn attribute, add typeof(AbpEntityFrameworkCoreOracleModule)

Also replace using Volo.Abp.EntityFrameworkCore.SqlServer; with using Volo.Abp.EntityFrameworkCore.Oracle;.


Find UseSqlServer() calls in your solution, replace with UseOracle(). Check the following files:

  • YourProjectNameEntityFrameworkCoreModule.cs inside the .EntityFrameworkCore project.
  • YourProjectNameDbContextFactory.cs inside the .EntityFrameworkCore project.

In the CreateDbContext() method of the YourProjectNameDbContextFactory.cs, replace the following code block

var builder = new DbContextOptionsBuilder<YourProjectNameDbContext>()

with this one (just changes UseSqlServer(...) to UseOracle(...))

var builder = new DbContextOptionsBuilder<YourProjectNameDbContext>()

Depending on your solution structure, you may find more code files need to be changed.

Change the Connection Strings

Oracle 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 for details of Oracle 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 by default. EF Core Migrations depend on the selected DBMS provider. Changing the DBMS provider, may not work with the existing migrations.

  • Delete the Migrations folder under the .EntityFrameworkCore project and re-build the solution.
  • Run Add-Migration "Initial" on the Package Manager Console window (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 scaffold a new migration for Oracle.

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

Run the Application

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

Was this page helpful?
Please make a selection.
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
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.