DEV Community

Cover image for 10-Day .Net Aspire Challenge: Day 2— Add MSSQL Component
Sukhpinder Singh
Sukhpinder Singh

Posted on • Originally published at Medium

10-Day .Net Aspire Challenge: Day 2— Add MSSQL Component

#dotnet #csharp #sql #aspire

Step-by-step guide on how to use the .Net Aspire MSSQL component in Visual Studio.

Introduction

.Net Aspire framework is used to develop cloud and production-ready distributed applications. It consists of components to handle cloud-native concerns such as Redis, Postgres etc.

Prerequisites

Objectives

Learn how to create a starter project using .Net Aspire with MSSQL EF Core component.

Github Sample: The solution structure is divided into the following projects

  • DotnetAspireChallenge.ApiService

  • DotnetAspireChallenge.AppHost

  • DotnetAspireChallenge.ServiceDefaults

  • DotnetAspireChallenge.Web

Getting Started

Step 1: Install the following NuGet package

Install the following Nuget package into the subsequent project “DotnetAspireChallenge.AppHost”

dotnet add package Aspire.Hosting.SqlServer
Enter fullscreen mode Exit fullscreen mode

In the above project, register a SQL server database and costume the SQL connection using following code.

    var sql = builder.AddSqlServer("sql")
                     .AddDatabase("sqldata");

    var apiService = builder.AddProject<Projects.DotnetAspireChallenge_ApiService>("apiservice")
        .WithReference(sql);
Enter fullscreen mode Exit fullscreen mode

Step 2: Install another NuGet package

Install the following Nuget package into the subsequent project “DotnetAspireChallenge.ApiService”

dotnet add package Aspire.Microsoft.EntityFrameworkCore.SqlServer
Enter fullscreen mode Exit fullscreen mode

then register the context into the Program.cs file as follows

    builder.AddSqlServerDbContext<MssqlDbContext>("sqldata");
Enter fullscreen mode Exit fullscreen mode

Step 3: Create a “Customer” class 

    public class Customer
    {
        public int Id { get; set; }

        [Required]
        public string Title { get; set; } = string.Empty;

        [Required]
        public string Description { get; set; } = string.Empty;
    }
Enter fullscreen mode Exit fullscreen mode

Step 4: Create an extension class

Create an extension class and register a minimal API get method to demonstrate the MSSQL context usage in the API Service

    public static class AspireMssqlExtension
    {
        public static void MapMssqlAspireEndpoint(this WebApplication app)
        {
            app.MapGet("/mssql", async (MssqlDbContext mssqlDbContext) =>
            {
                await mssqlDbContext.Customers.AddAsync(new Customer()
                {
                    Title = "test@gmail.com",
                    Description = "sukh"
                });
                int rows = await mssqlDbContext.SaveChangesAsync();
                if (rows > 0)
                {
                    return await mssqlDbContext.Customers.FirstOrDefaultAsync();
                }
                else
                {
                    return null;
                }
            });
        }
    }

    internal class MssqlDbContext(DbContextOptions options) : DbContext(options)
    {
        public DbSet<Customer> Customers => Set<Customer>();
    }
Enter fullscreen mode Exit fullscreen mode

and finally, register in the Program.cs file

    app.MapMssqlAspireEndpoint();
Enter fullscreen mode Exit fullscreen mode

Step 5: Hit the GET endpoint

Finally, navigate to the GET URL shown below in your browser. It will insert the specified customer into the MSSQL database, retrieve the most recently inserted row, and display it as a response.

Add additional connection string properties using the JSON syntax

    {
      "Aspire": {
        "Microsoft": {
          "EntityFrameworkCore": {
              "SqlServer": {
                "ConnectionString": "YOUR_CONNECTIONSTRING",
                "DbContextPooling": true,
                "DisableHealthChecks": true,
                "DisableTracing": true,
                "DisableMetrics": false,
              "AnotherDbContext": {
                "ConnectionString": "AnotherDbContext_CONNECTIONSTRING",
                "DisableTracing": false
              }
            }
          }
        }
      }
    }
Enter fullscreen mode Exit fullscreen mode

Congratulations..!! You’ve successfully integrated the MSSQL component into the .Net Aspire project.

Github Project

GitHub - ssukhpinder/DotnetAspireChallenge: 10 Day .Net Aspire Challenge

More Cheatsheets

Cheat Sheets — .Net

C# Programming🚀

Thank you for being a part of the C# community! Before you leave:

Follow us: Youtube | X | LinkedIn | Dev.to
Visit our other platforms: GitHub
More content at C# Programming

Top comments (0)

Read next

kamaleshs48 profile image

ASP .NET Core Best Practices

Kamlesh Singh -

dazevedo profile image

Why Design Patterns Matter in C# Development

Daniel Azevedo -

tigawanna profile image

supabase functions (not edge)

Dennis kinuthia -

lukesilva profile image

TestContainers for integration testing .Net applications

👨‍💻 Lucas Silva -