Aspire.Microsoft.Data.SqlClient library

Registers 'Scoped' Microsoft.Data.SqlClient.SqlConnection factory in the DI container for connecting Azure SQL, MS SQL database. Enables health check and telemetry.

Getting started

Prerequisites

• Azure SQL or MS SQL server database and the connection string for accessing the database.

Install the package

Install the Aspire SQL Server SqlClient library with NuGet:

dotnet add package Aspire.Microsoft.Data.SqlClient

Usage example

In the AppHost.cs file of your project, call the AddSqlServerClient extension method to register a SqlConnection for use via the dependency injection container. The method takes a connection name parameter.

builder.AddSqlServerClient("sqldata");

You can then retrieve the SqlConnection instance using dependency injection. For example, to retrieve the connection from a Web API controller:

private readonly SqlConnection _connection; public ProductsController(SqlConnection connection) { _connection = connection; }

Configuration

The Aspire SqlClient component provides multiple options to configure the SQL connection based on the requirements and conventions of your project.

Use a connection string

When using a connection string from the ConnectionStrings configuration section, you can provide the name of the connection string when calling builder.AddSqlServerClient():

builder.AddSqlServerClient("myConnection");

And then the connection string will be retrieved from the ConnectionStrings configuration section:

{ "ConnectionStrings": { "myConnection": "Data Source=myserver;Initial Catalog=master" } }