Aspire.Hosting.MySql 13.1.0

Prefix Reserved

dotnet add package Aspire.Hosting.MySql --version 13.1.0

NuGet\Install-Package Aspire.Hosting.MySql -Version 13.1.0

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Aspire.Hosting.MySql" Version="13.1.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Aspire.Hosting.MySql" Version="13.1.0" />
                    

                            Directory.Packages.props

<PackageReference Include="Aspire.Hosting.MySql" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add Aspire.Hosting.MySql --version 13.1.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Aspire.Hosting.MySql, 13.1.0"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package Aspire.Hosting.MySql@13.1.0

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=Aspire.Hosting.MySql&version=13.1.0
                    

                            Install as a Cake Addin

#tool nuget:?package=Aspire.Hosting.MySql&version=13.1.0
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

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
`DatabaseName`	The MySQL database name
`Uri`	The database-specific URI, with the format `mysql://root:{Password}@{Host}:{Port}/{DatabaseName}`
`JdbcConnectionString`	The database-specific JDBC connection string, with the format `jdbc:mysql://{Host}:{Port}/{DatabaseName}`. 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

https://learn.microsoft.com/dotnet/aspire/database/mysql-component

Feedback & contributing

https://github.com/dotnet/aspire

Product	Compatible and additional computed target framework versions.
.NET	net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net8.0
- Aspire.Hosting (>= 13.1.0)
- AspNetCore.HealthChecks.MySql (>= 9.0.0)
- AspNetCore.HealthChecks.Uris (>= 9.0.0)
- Google.Protobuf (>= 3.33.0)
- Grpc.AspNetCore (>= 2.71.0)
- Grpc.Net.ClientFactory (>= 2.71.0)
- Grpc.Tools (>= 2.72.0)
- Humanizer.Core (>= 2.14.1)
- JsonPatch.Net (>= 3.3.0)
- KubernetesClient (>= 18.0.5)
- Microsoft.Extensions.Configuration.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.2)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.2)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.22)
- Microsoft.Extensions.FileSystemGlobbing (>= 10.0.1)
- Microsoft.Extensions.Hosting (>= 8.0.1)
- Microsoft.Extensions.Hosting.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Http (>= 8.0.1)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.3)
- Microsoft.Extensions.Options (>= 8.0.2)
- Microsoft.Extensions.Primitives (>= 8.0.0)
- Newtonsoft.Json (>= 13.0.4)
- Polly.Core (>= 8.6.4)
- Semver (>= 3.0.0)
- StreamJsonRpc (>= 2.22.23)
- System.IO.Hashing (>= 9.0.10)

NuGet packages (2)

Showing the top 2 NuGet packages that depend on Aspire.Hosting.MySql:

Package	Downloads
CommunityToolkit.Aspire.Hosting.MySql.Extensions A .NET Aspire integration for extending mysql hosting.	22.0K
YMJake.Aspire.Hosting.Apollo Hosting extensions for running Apollo Configuration Center with .NET Aspire (config service, admin service, portal, MySQL init scripts included).	225

GitHub repositories (3)

Showing the top 3 popular GitHub repositories that depend on Aspire.Hosting.MySql:

Repository	Stars
bitfoundation/bitplatform Build all of your apps using what you already know and love ❤️	1.3K
dotnet/aspire-samples	1.1K
CommunityToolkit/Aspire A community project with additional components and extensions for Aspire	568

Version	Downloads	Last Updated
13.1.0	11,317	12/17/2025
13.0.2	3,004	12/4/2025
13.0.1	1,332	11/26/2025
13.0.0	11,324	11/11/2025
9.5.2	9,594	10/23/2025
9.5.1	10,462	10/3/2025
9.5.0	5,224	9/25/2025
9.4.2	4,340	9/2/2025
9.4.1	7,118	8/12/2025
9.4.0	4,206	7/29/2025
9.3.1	19,535	6/10/2025
9.3.0	8,749	5/19/2025
9.2.1	2,312	4/24/2025
9.2.0	4,592	4/10/2025
9.1.0	5,085	2/25/2025
9.0.0	15,645	11/12/2024
9.0.0-rc.1.24511.1	925	10/15/2024
8.2.2	6,923	10/24/2024
8.2.1	4,415	9/26/2024
8.2.0	7,117	8/29/2024
8.1.0	3,886	7/23/2024
8.0.2	1,218	6/28/2024
8.0.1	3,981	5/21/2024
8.0.0	935	5/21/2024
8.0.0-preview.7.24251.11	668	5/7/2024
8.0.0-preview.6.24214.1	724	4/23/2024
8.0.0-preview.5.24201.12	1,603	4/9/2024