Aspire.Hosting.MySql 13.0.2
Aspire.Hosting.MySql library
Provides extension methods and resource definitions for an Aspire AppHost to configure a MySQL resource.
Getting started
Install the package
In your AppHost project, install the Aspire MySQL Hosting library with NuGet:
dotnet add package Aspire.Hosting.MySql
Usage example
Then, in the AppHost.cs file of AppHost, add a MySQL resource and consume the connection using the following methods:
var db = builder.AddMySql("mysql").AddDatabase("mydb");
var myService = builder.AddProject<Projects.MyService>()
.WithReference(db);
Connection Properties
When you reference a MySQL resource using WithReference, the following connection properties are made available to the consuming project:
MySQL server
The MySQL server resource exposes the following connection properties:
| Property Name | Description |
|---|---|
Host |
The hostname or IP address of the MySQL server |
Port |
The port number the MySQL server is listening on |
Username |
The username for authentication |
Password |
The password for authentication |
Uri |
The connection URI, with the format mysql://root:{Password}@{Host}:{Port} |
JdbcConnectionString |
The JDBC connection string for MySQL, with the format jdbc:mysql://{Host}:{Port}. User and password credentials are provided as separate Username and Password properties. |
MySQL database
The MySQL database resource combines the server properties above and adds the following connection properties:
| Property Name | Description |
|---|---|
Database |
The MySQL database name |
Uri |
The database-specific URI, with the format mysql://root:{Password}@{Host}:{Port}/{Database} |
JdbcConnectionString |
The database-specific JDBC connection string, with the format jdbc:mysql://{Host}:{Port}/{Database}. User and password credentials are provided as separate Username and Password properties. |
Aspire exposes each property as an environment variable named [RESOURCE]_[PROPERTY]. For instance, the Uri property of a resource called db1 becomes DB1_URI.
Additional documentation
Feedback & contributing
No packages depend on Aspire.Hosting.MySql.
.NET 8.0
- Aspire.Hosting (>= 13.0.2)
- System.IO.Hashing (>= 9.0.10)
- StreamJsonRpc (>= 2.22.23)
- Semver (>= 3.0.0)
- Polly.Core (>= 8.6.4)
- Newtonsoft.Json (>= 13.0.4)
- Microsoft.Extensions.Primitives (>= 8.0.0)
- Microsoft.Extensions.Options (>= 8.0.2)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.3)
- Microsoft.Extensions.Http (>= 8.0.1)
- Microsoft.Extensions.Hosting.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Hosting (>= 8.0.1)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.22)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.2)
- Microsoft.Extensions.Configuration.Abstractions (>= 8.0.0)
- KubernetesClient (>= 18.0.5)
- JsonPatch.Net (>= 3.3.0)
- Humanizer.Core (>= 2.14.1)
- Grpc.Tools (>= 2.72.0)
- Grpc.Net.ClientFactory (>= 2.71.0)
- Grpc.AspNetCore (>= 2.71.0)
- Google.Protobuf (>= 3.33.0)
- AspNetCore.HealthChecks.Uris (>= 9.0.0)
- AspNetCore.HealthChecks.MySql (>= 9.0.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.2)
| Version | Downloads | Last updated |
|---|---|---|
| 13.1.0 | 4 | 12/21/2025 |
| 13.0.2 | 3 | 12/7/2025 |
| 13.0.1 | 4 | 11/30/2025 |
| 13.0.0 | 4 | 11/16/2025 |
| 9.5.2 | 5 | 10/26/2025 |
| 9.5.1 | 6 | 10/11/2025 |
| 9.5.0 | 6 | 9/27/2025 |
| 9.4.2 | 6 | 9/6/2025 |
| 9.4.1 | 8 | 8/16/2025 |
| 9.4.0 | 7 | 8/17/2025 |
| 9.3.1 | 1 | 6/21/2025 |
| 9.3.0 | 2 | 6/21/2025 |
| 9.2.1 | 2 | 6/21/2025 |
| 9.2.0 | 2 | 6/21/2025 |
| 9.1.0 | 2 | 6/21/2025 |
| 9.0.0 | 2 | 6/21/2025 |
| 9.0.0-rc.1.24511.1 | 8 | 7/6/2025 |
| 8.2.2 | 5 | 6/21/2025 |
| 8.2.1 | 5 | 6/21/2025 |
| 8.2.0 | 2 | 6/21/2025 |
| 8.1.0 | 2 | 6/21/2025 |
| 8.0.2 | 9 | 6/21/2025 |
| 8.0.1 | 3 | 6/21/2025 |
| 8.0.0 | 3 | 6/21/2025 |
| 8.0.0-preview.7.24251.11 | 1 | 6/20/2025 |
| 8.0.0-preview.6.24214.1 | 9 | 7/7/2025 |
| 8.0.0-preview.5.24201.12 | 9 | 6/26/2025 |