Search  
Always will be ready notify the world about expectations as easy as possible: job change page
Jan 11, 2023

Database setup with DbUp + PostgreSQL + Dapper in ASP.Net Core

Author:
Nitesh Singhal
Source:
Views:
2605

Database Setup with DbUp + Postgresql + Dapper in ASP.Net Core

In this tutorial, we are going to explore how we can setup our database on startup when using Dapper for accessing database.

When using Dapper, one of the key learning I came to know is that we have to have database and tables already created in advance in order to read/write data.

So we have to write some kind of migration logic in our code before we access database.

Now we could do that our own, but what if there is any library which could this for you.

Or if you have your SQL scripts already written and you want to reuse them for your database creation.

DbUp can help us in achieving all of it.

Let’s understand with example.

Example

Create a ASP.Net core web API in Visual Studio Or VSCode.

as mention I am using Postgresql for database, so will add the required nuget package.

Install-Package Dapper
Install-Package Npgsql

and Create a database and Create Table manually using PgAdmin tool.

Database creation

Table creation

Let’s define the connection string in appsetting.json

Connection string

Repository

Interface for Repository

One sample example using Dapper

Controller

Sample controller

We can run our app and test if we are able to read/write data.

Using DbUp

This was good till now, but there was one problem, I had to create database and tables manually.

Now this is ok for development but for production scenario specially automated deployment scenarios this will not be OK.

DbUp can help us integrate sql script and setup database on startup.

First cleanup the database by dropping previously created database and tables.

Add the required nuget package

Install-Package dbup-postgresql

Let’s add those script to project.

Project structure with script folder

SQL Script for creating table

Embedding the script as a project resource

and Create a extension class for adding Migration code using DbUp.

public static class DatabaseExtension
{
    public static IHost MigrateDatabase<TContext>(this IHost host)
    {
        using (var scope = host.Services.CreateScope())
        {
            var services = scope.ServiceProvider;
            var configuration = services.GetRequiredService<IConfiguration>();
            var logger = services.GetRequiredService<ILogger<TContext>>();

            logger.LogInformation("Migrating postresql database.");

            string connection = configuration.GetValue<string>("DatabaseSettings:ConnectionString");

            EnsureDatabase.For.PostgresqlDatabase(connection);

            var upgrader = DeployChanges.To
                .PostgresqlDatabase(connection)
                .WithScriptsEmbeddedInAssembly(Assembly.GetExecutingAssembly())
                .LogToConsole()
                .Build();

            var result = upgrader.PerformUpgrade();

            if (!result.Successful)
            {
                logger.LogError(result.Error, "An error occurred while migrating the postresql database");
                return host;
            }

            logger.LogInformation("Migrated postresql database.");
        }

        return host;
    }
}

Program.cs

Changes in Program.cs

Our changes are ready. Let’s run the app and see the output window

Output window

As we can in the output window logs, it executed the SQL scripts and created the required database and tables.

Now we can call the API and query for data.

You can find full source code at GitHub.

Summary

Using DbUp we can easily integrate our existing SQL Scripts and make the database ready before any operation.

It is supported for different databases.

https://dbup.readthedocs.io/en/latest/supported-databases/

Hope it is helpful.

Similar
May 29, 2023
Maximizing performance in asynchronous programmingTask and Task<TResult>The Task and Task<TResult> types were introduced in .NET 4.0 as part of the Task Parallel Library (TPL) in 2010, which provided a new model for writing multithreaded and asynchronous code.For demonstration purposes, let’s...
Jun 27, 2023
Author: Anton Selin
IntroductionPerformance optimization is a key concern in software development, regardless of the programming language or platform you’re using. It’s all about making your software run faster or with less memory consumption, leading to better user experience and more efficient resource...
Jun 1
Author: Akalanka Dissanayake
In the second part of our series, the focus shifts towards validating the security and reliability of our ASP.NET 8 Web API through comprehensive integration testing. Integration testing plays a critical role in ensuring that our authentication mechanisms work as...
Jul 16, 2021
Author: Robert Sheldon
SQL Server performance tuning can seem overwhelming when you don’t know where to start. In this article Robert Sheldon explains 9 best practices for performance tuning.SQL Server is a powerful and feature-rich database management platform that can support a wide...
Send message
Email
Your name
*Message


© 1999–2024 WebDynamics
1980–... Sergey Drozdov
Area of interests: .NET Framework | .NET Core | C# | ASP.NET | Windows Forms | WPF | HTML5 | CSS3 | jQuery | AJAX | Angular | React | MS SQL Server | Transact-SQL | ADO.NET | Entity Framework | IIS | OOP | OOA | OOD | WCF | WPF | MSMQ | MVC | MVP | MVVM | Design Patterns | Enterprise Architecture | Scrum | Kanban