Compartir a través de

.NET Aspire MySQL integración

Incluye:Integración de alojamiento incluida Integración de alojamiento —&— Client integración incluidaClient integración

MySQL es un sistema de administración de bases de datos relacionales (RDBMS) de código abierto que usa lenguaje de consulta estructurado (SQL) para administrar y manipular datos. Se emplea en muchos entornos diferentes, desde proyectos pequeños hasta sistemas empresariales a gran escala y es una opción popular hospedar datos que respaldan microservicios en una aplicación nativa de nube. La integración de base de datos .NET AspireMySQL permite conectarse a bases de datos de MySQL existentes o crear nuevas instancias desde .NET con la imagen de contenedor mysql.

Integración de hospedaje

La integración de alojamiento MySQL modela los modelos de integración del servidor como el tipo MySqlServerResource y la base de datos como el tipo MySqlDatabaseResource. Para acceder a estos tipos y API, agregue el paquete NuGet 📦Aspire.Hosting.MySql en el proyecto de la aplicación host .

dotnet add package Aspire.Hosting.MySql

Para obtener más información, consulte dotnet add package o Manage package dependencies in .NET applications.

Agregar MySQL recurso de servidor y recurso de base de datos

En el proyecto host de la aplicación, utilice AddMySql para agregar y devolver un constructor de recursos MySQL. Enlaza una llamada al generador de recursos devuelto a AddDatabasepara agregar un recurso de base de datos MySQL.

var builder = DistributedApplication.CreateBuilder(args);

var mysql = builder.AddMySql("mysql")
                   .WithLifetime(ContainerLifetime.Persistent);

var mysqldb = mysql.AddDatabase("mysqldb");

var myService = builder.AddProject<Projects.ExampleProject>()
                       .WithReference(mysqldb)
                       .WaitFor(mysqldb);

// After adding all resources, run the app...

Nota:

El contenedor de SQL Server tarda en arrancar, por lo que es mejor usar una vida útil persistente para evitar reinicios innecesarios. Para obtener más información, consulte ciclo de vida de los recursos del contenedor.

Cuando .NET.NET Aspire agrega una imagen de contenedor al host de la aplicación, como se muestra en el ejemplo anterior con la imagen de mysql, crea una nueva instancia de MySQL en el equipo local. Se usa una referencia al generador de recursos de MySQL (la variable mysql) para agregar una base de datos. La base de datos se denomina mysqldb y, a continuación, se agrega al ExampleProject. El recurso MySQL incluye credenciales predeterminadas con un username de root y un password aleatorio generado mediante el método CreateDefaultPasswordParameter.

Cuando se ejecuta el host de la aplicación, la contraseña se almacena en el almacén de secretos del host de la aplicación. Se agrega a la sección Parameters, por ejemplo:

{
  "Parameters:mysql-password": "<THE_GENERATED_PASSWORD>"
}

El nombre del parámetro es mysql-password, pero realmente solo da formato al nombre del recurso con un sufijo -password. Para obtener más información, consulte Almacenamiento seguro de secretos de aplicaciones en desarrollo en ASP.NET Core y Adición de recurso MySQL con parámetros.

El método WithReference configura una conexión en el ExampleProject denominado mysqldb.

Sugerencia

Si prefiere conectarse a un servidor MySQL existente, llame a AddConnectionString en su lugar. Para obtener más información, consulte Referencia de recursos existentes.

Agregar un recurso MySQL con un volumen de datos

Para agregar un volumen de datos al recurso de SQL Server, llame al método WithDataVolume en el recurso SQL Server:

var builder = DistributedApplication.CreateBuilder(args);

var mysql = builder.AddMySql("mysql")
                   .WithDataVolume();

var mysqldb = mysql.AddDatabase("mysqldb");

builder.AddProject<Projects.ExampleProject>()
       .WithReference(mysqldb)
       .WaitFor(mysqldb);

// After adding all resources, run the app...

El volumen de datos se usa para conservar los datos del servidor de MySQL fuera del ciclo de vida de su contenedor. El volumen de datos se monta en la ruta /var/lib/mysql dentro del contenedor SQL Server y, si no se proporciona un parámetro name, el nombre se genera de manera aleatoria. Para obtener más información sobre los volúmenes de datos y los detalles sobre por qué se prefieren a bind mounts, consulte la Docker documentación: Volúmenes.

Advertencia

La contraseña se almacena en el volumen de datos. Cuando se utiliza un volumen de datos y cambia la contraseña, no funcionará hasta que se elimine el volumen.

Importante

Algunas integraciones de base de datos, incluida la .NET AspireMySQL integración, no pueden usar correctamente volúmenes de datos después de la implementación en Azure Container Apps (ACA). Esto se debe a que ACA usa Server el bloque de mensajes (SMB) para conectar contenedores a volúmenes de datos y algunos sistemas no pueden usar esta conexión. En el Aspire Panel, una base de datos afectada por este problema tiene el estado Activación o Error de activación , pero nunca aparece como En ejecución.

Puede resolver el problema mediante la implementación en un Kubernetes clúster, como AzureKubernetes Servicios (AKS). Para obtener más información, consulte .NET.NET Aspire despliegues.

Agrega un recurso MySQL con una vinculación de datos

Para agregar una montura de enlace de datos al recurso de MySQL, llame al método WithDataBindMount.

var builder = DistributedApplication.CreateBuilder(args);

var mysql = builder.AddMySql("mysql")
                   .WithDataBindMount(source: @"C:\MySql\Data");

var db = sql.AddDatabase("mysqldb");

builder.AddProject<Projects.ExampleProject>()
       .WithReference(mysqldb)
       .WaitFor(mysqldb);

// After adding all resources, run the app...

Importante

Los montajes de enlace de datos tienen una funcionalidad limitada en comparación con los volúmenes , que ofrecen mejor rendimiento, portabilidad y seguridad, por lo que son más apropiados para entornos de producción. Sin embargo, los bind mounts permiten el acceso directo y la modificación de archivos en el sistema host, lo que es ideal para el desarrollo y las pruebas donde se necesitan cambios en tiempo real.

Los montajes de enlace de datos dependen del sistema de archivos del equipo host para preservar los datos de MySQL cada vez que se reinicia el contenedor. El punto de montaje de enlace de datos se monta en la ruta C:\MySql\Data en Windows (o /MySql/Data en Unix) en el equipo host dentro del contenedor MySQL. Para obtener más información sobre los montajes vinculados de datos, consulte la documentación Docker: Montajes vinculados.

Añadir recurso MySQL con parámetros

Cuando desee proporcionar explícitamente una contraseña de raíz MySQL, puede pasarla como parámetro. Considere el siguiente ejemplo alternativo:

var password = builder.AddParameter("password", secret: true);

var mysql = builder.AddMySql("mysql", password)
                   .WithLifetime(ContainerLifetime.Persistent);

var mysqldb = mysql.AddDatabase("mysqldb");

var myService = builder.AddProject<Projects.ExampleProject>()
                       .WithReference(mysqldb)
                       .WaitFor(mysqldb);

Para obtener más información, vea Parámetros externos.

Adición de un recurso PhpMyAdmin

phpMyAdmin es una popular herramienta de administración basada en web para MySQL. Puede usarlo para examinar y modificar MySQL objetos como bases de datos, tablas, vistas e índices. Para usar phpMyAdmin en la solución de .NET.NET Aspire, llame al método WithPhpMyAdmin. Este método agrega un nuevo recurso de contenedor a la solución que hospeda phpMyAdmin y lo conecta al contenedor de MySQL:

var builder = DistributedApplication.CreateBuilder(args);

var mysql = builder.AddMySql("mysql")
                   .WithPhpMyAdmin();

var db = sql.AddDatabase("mysqldb");

builder.AddProject<Projects.ExampleProject>()
       .WithReference(mysqldb)
       .WaitFor(mysqldb);

// After adding all resources, run the app...

Al ejecutar la solución, el tablero .NET.NET Aspire muestra los recursos phpMyAdmin con un punto de conexión. Seleccione el vínculo al punto de conexión para ver phpMyAdmin en una nueva pestaña del explorador.

Comprobaciones de estado de la integración de hospedaje

La integración de hospedaje MySQL agrega automáticamente una comprobación de estado para el recurso MySQL. La comprobación de estado comprueba que el MySQL servidor se está ejecutando y que se puede establecer una conexión a él.

La integración de hospedaje se basa en el paquete NuGet de 📦 AspNetCore.HealthChecks.MySql.

integración Client

Para empezar a trabajar con la integración de la base de datos .NET AspireMySQL, instale el paquete NuGet 📦Aspire.MySqlConnector en el proyecto que consume el cliente, es decir, el proyecto de la aplicación que utiliza el cliente MySQL. La MySQL integración de cliente registra una MySqlConnector.MySqlDataSource instancia que puede usar para interactuar con el MySQL servidor.

dotnet add package Aspire.MySqlConnector

Para obtener más información, consulte dotnet add package o Manage package dependencies in .NET applications.

Añadir un origen de datos de MySQL

En el archivo Program.cs del proyecto cliente-consumidor, llame al método de extensión AddMySqlDataSource para registrar un MySqlDataSource para su uso a través del contenedor de inyección de dependencias. El método toma un parámetro connectionName.

builder.AddMySqlDataSource(connectionName: "mysqldb");

Sugerencia

El parámetro connectionName debe coincidir con el nombre usado al agregar el recurso de base de datos MySQL en el proyecto host de la aplicación. Es decir, cuando se llama a AddDatabase y se proporciona un nombre de mysqldb ese mismo nombre se debe usar al llamar a AddMySqlDataSource. Para obtener más información, consulte Añadir MySQL recurso de servidor y recurso de base de datos.

A continuación, puede recuperar la instancia MySqlConnector.MySqlDataSource usando la inyección de dependencias. Por ejemplo, para recuperar el origen de datos de un servicio de ejemplo:

public class ExampleService(MySqlDataSource dataSource)
{
    // Use dataSource...
}

Para obtener más información sobre la inyección de dependencias, consulte .NET inyección de dependencias.

Agregar origen de datos MySQL claveada

Puede haber situaciones en las que quiera registrar varias instancias de MySqlDataSource con nombres de conexión diferentes. Para registrar los orígenes de datos con clave MySQL, llame al método AddKeyedMySqlDataSource:

builder.AddKeyedMySqlDataSource(name: "mainDb");
builder.AddKeyedMySqlDataSource(name: "loggingDb");

Importante

Cuando se usan servicios con claves, se espera que el recurso de MySQL configure dos bases de datos con nombre, una para el mainDb y otra para la loggingDb.

A continuación, puede recuperar las instancias de MySqlDatSource usando inyección de dependencias. Por ejemplo, para recuperar la conexión de un servicio de ejemplo:

public class ExampleService(
    [FromKeyedServices("mainDb")] MySqlDataSource mainDbConnection,
    [FromKeyedServices("loggingDb")] MySqlDataSource loggingDbConnection)
{
    // Use connections...
}

Para obtener más información sobre los servicios con clave, consulte .NET Inserción de Dependencias: Servicios con Clave.

Configuración

La integración de base de datos .NET AspireMySQL proporciona varias opciones para configurar la conexión en función de los requisitos y convenciones del proyecto.

Uso de una cadena de conexión

Al usar una cadena de conexión de la sección de configuración de ConnectionStrings, puede proporcionar el nombre de la cadena de conexión al llamar al método AddMySqlDataSource:

builder.AddMySqlDataSource(connectionName: "mysql");

A continuación, se obtiene la cadena de conexión de la sección de configuración ConnectionStrings.

{
  "ConnectionStrings": {
    "mysql": "Server=mysql;Database=mysqldb"
  }
}

Para obtener más información sobre cómo dar formato a esta cadena de conexión, consulte Documentación de MySqlConnector: ConnectionString.

Uso de proveedores de configuración

La integración de la base de datos .NET AspireMySQL admite Microsoft.Extensions.Configuration. Carga el MySqlConnectorSettings desde la configuración usando la clave Aspire:MySqlConnector. El fragmento de código siguiente es un ejemplo de un archivo appsettings.json que configura algunas de las opciones:

{
  "Aspire": {
    "MySqlConnector": {
      "ConnectionString": "YOUR_CONNECTIONSTRING",
      "DisableHealthChecks": true,
      "DisableTracing": true
    }
  }
}

Para obtener el esquema de integración MySQL completoJSON, consulte Aspire. MySqlConnector/ConfigurationSchema.json.

Usa delegados en línea

También puede pasar el delegado Action<MySqlConnectorSettings> para configurar algunas o todas las opciones en línea, por ejemplo, para deshabilitar desde el código las comprobaciones de salud:

builder.AddMySqlDataSource(
    "mysql",
    static settings => settings.DisableHealthChecks  = true);

Client verificaciones de estado de la integración

De forma predeterminada, las integraciones de .NET.NET Aspire habilitan las comprobaciones de integridad de para todos los servicios. Para obtener más información, consulte .NET.NET Aspire integrations overview.

La integración de la base de datos .NET AspireMySQL:

  • Agrega la comprobación de estado cuando MySqlConnectorSettings.DisableHealthChecks es false, que comprueba que se puede realizar una conexión y que los comandos se pueden ejecutar en la base de datos MySQL.
  • Se integra con el endpoint HTTP de /health, que exige que todas las verificaciones de estado registradas se completen con éxito para que la aplicación se considere lista para aceptar tráfico.

Observabilidad y telemetría

.NET .NET Aspire integraciones configuran automáticamente las configuraciones de registro, seguimiento y métricas, que a veces se conocen como los pilares de la observabilidad. Para obtener más información sobre la observabilidad de integración y la telemetría, consulte información general sobre las integraciones de .NET.NET Aspire. En función del servicio de respaldo, algunas integraciones solo pueden admitir algunas de estas características. Por ejemplo, algunas integraciones admiten el registro y el seguimiento, pero no las métricas. Las características de telemetría también se pueden deshabilitar mediante las técnicas presentadas en la sección Configuración.

Registro

La integración de .NET AspireMySQL usa las siguientes categorías de registro:

  • MySqlConnector.ConnectionPool
  • MySqlConnector.MySqlBulkCopy
  • MySqlConnector.MySqlCommand
  • MySqlConnector.MySqlConnection
  • MySqlConnector.MySqlDataSource

Rastreo

La integración de .NET AspireMySQL emite las siguientes actividades de seguimiento mediante OpenTelemetry:

  • MySqlConnector

Métricas

La integración de .NET AspireMySQL emitirá las métricas siguientes mediante OpenTelemetry:

  • MySqlConnector
    • db.client.connections.create_time
    • db.client.connections.use_time
    • db.client.connections.wait_time
    • db.client.connections.idle.max
    • db.client.connections.idle.min
    • db.client.connections.max
    • db.client.connections.pending_requests
    • db.client.connections.timeouts
    • db.client.connections.usage

Consulte también