AspireMySqlConnectorExtensions.AddMySqlDataSource Method

Reference

Definition

Namespace:: Microsoft.Extensions.Hosting

Assembly:: Aspire.MySqlConnector.dll

Package:: Aspire.MySqlConnector v8.0.0

Package:: Aspire.MySqlConnector v8.0.1

Source:: AspireMySqlConnectorExtensions.cs

Source:: AspireMySqlConnectorExtensions.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Registers MySqlConnector.MySqlDataSource service for connecting MySQL database with MySqlConnector client. Configures health check, logging and telemetry for the MySqlConnector client.

public static void AddMySqlDataSource (this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string connectionName, Action<Aspire.MySqlConnector.MySqlConnectorSettings>? configureSettings = default);

static member AddMySqlDataSource : Microsoft.Extensions.Hosting.IHostApplicationBuilder * string * Action<Aspire.MySqlConnector.MySqlConnectorSettings> -> unit

<Extension()>
Public Sub AddMySqlDataSource (builder As IHostApplicationBuilder, connectionName As String, Optional configureSettings As Action(Of MySqlConnectorSettings) = Nothing)

Parameters

builder: IHostApplicationBuilder

The IHostApplicationBuilder to read config from and add services to.

connectionName: String

A name used to retrieve the connection string from the ConnectionStrings configuration section.

configureSettings: Action<MySqlConnectorSettings>

An optional delegate that can be used for customizing options. It's invoked after the settings are read from the configuration.

Exceptions

ArgumentNullException

Thrown if mandatory builder is null.

InvalidOperationException

Thrown when mandatory ConnectionString is not provided.

Remarks

Reads the configuration from "Aspire:MySqlConnector" section.

Applies to

Share via