Aspire.Hosting.MySql 13.4.6

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:

MySQL database

The MySQL database resource combines the server properties above and adds the following connection 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://aspire.dev/integrations/databases/mysql/

Feedback & contributing

https://github.com/microsoft/aspire