Get started with the SQL Server integrations

SQL Server is a relational database management system developed by Microsoft. The Aspire SQL Server integration lets you model a SQL Server instance and its databases as first-class resources in your AppHost, then hand the connection information to any consuming app — regardless of language.

Why use SQL Server with Aspire

Adding SQL Server through Aspire — rather than wiring up containers and connection strings by hand — gives you:

• Zero-config local development. Aspire runs SQL Server from the mcr.microsoft.com/mssql/server container image with credentials generated automatically for you.
• Consistent connection info across languages. Once you reference the database from a consuming app, Aspire injects connection properties as environment variables in a predictable format that works from C#, TypeScript, Python, Go, or any other language.
• Built-in health checks. The hosting integration automatically registers a health check so the dashboard and your orchestrator can tell when the server is ready.
• Dashboard observability. The database resource shows up in the Aspire dashboard with logs, status, and telemetry alongside your other services.
• A first-class C# client integration. C# apps can use the Aspire.Microsoft.Data.SqlClient package for dependency injection, health checks, and OpenTelemetry, all wired up from the same resource name.

How the pieces fit together

The SQL Server integration has two sides: a hosting integration that you use in your AppHost to model the database resource, and a connection story for consuming apps that reference it.

architecture-beta

  group apphost(server)[AppHost]
  group consumer(server)[Consuming app]

  service hosting(server)[Hosting integration] in apphost
  service sqlserver(database)[SQL Server] in apphost
  service db(database)[sqldb] in apphost

  service client(iconoir:server-connection)[Client integration] in consumer
  service app(server)[App] in consumer

  hosting:R --> L:sqlserver
  sqlserver:R --> L:db
  db:R --> L:client
  client:R --> L:app

The hosting integration lives in your AppHost project and models the SQL Server instance and databases as resources. The client integration lives in each consuming app and uses the connection information Aspire injects to talk to the database.

Getting there is a two-step process: model the SQL Server resources in your AppHost, then connect to the database from each app that needs it.

1. Model SQL Server in your AppHost

   Add the SQL Server hosting integration to your AppHost, then declare a SQL Server instance, one or more databases, and reference them from the apps that need to talk to the database. The SQL Server Hosting integration article walks through every capability — adding databases, data volumes, bind mounts, custom parameters, image tags, and more — with side-by-side C# and TypeScript examples.

   Set up SQL Server in the AppHost

2. Connect from your consuming app

   When you reference a SQL Server database from a consuming app, Aspire injects its connection information as environment variables. See Connect to SQL Server for the connection properties reference and per-language examples for C#, Go, Python, and TypeScript — including the full C# client integration.

   Connect to SQL Server

See also

• SQL Server community extensions
• SQL Server Entity Framework Core integrations