EntityFrameworkCoreHealthChecksBuilderExtensions.AddDbContextCheck<TContext> Metoda

Definice

Obor názvů:

Microsoft.Extensions.DependencyInjection

Sestavení:

Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore.dll

Balíček:

Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore v9.0.0

Zdroj:

EntityFrameworkCoreHealthChecksBuilderExtensions.cs

Přidá kontrolu stavu pro zadaný DbContext typ.

public static Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder AddDbContextCheck<TContext> (this Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder builder, string? name = default, Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus? failureStatus = default, System.Collections.Generic.IEnumerable<string>? tags = default, Func<TContext,System.Threading.CancellationToken,System.Threading.Tasks.Task<bool>>? customTestQuery = default) where TContext : Microsoft.EntityFrameworkCore.DbContext;

static member AddDbContextCheck : Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder * string * Nullable<Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus> * seq<string> * Func<'Context, System.Threading.CancellationToken, System.Threading.Tasks.Task<bool> (requires 'Context :> Microsoft.EntityFrameworkCore.DbContext)> -> Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder (requires 'Context :> Microsoft.EntityFrameworkCore.DbContext)

<Extension()>
Public Function AddDbContextCheck(Of TContext As DbContext) (builder As IHealthChecksBuilder, Optional name As String = Nothing, Optional failureStatus As Nullable(Of HealthStatus) = Nothing, Optional tags As IEnumerable(Of String) = Nothing, Optional customTestQuery As Func(Of TContext, CancellationToken, Task(Of Boolean)) = Nothing) As IHealthChecksBuilder

Parametry typu

TContext

Typ DbContext .

Parametry

builder

IHealthChecksBuilder

Hodnota IHealthChecksBuilder

name

String

Název kontroly stavu. Nepovinný parametr. Pokud null se jako název použije název TContext typu .

failureStatus

Nullable<HealthStatus>

Hodnota HealthStatus , která by se měla hlásit, když se kontrola stavu nezdaří. Nepovinný parametr. Pokud null se pak bude hlásit výchozí stav .Unhealthy

tags

IEnumerable<String>

Seznam značek, které lze použít k filtrování sad kontrol stavu. Nepovinný parametr.

customTestQuery

Func<TContext,CancellationToken,Task<Boolean>>

Vlastní testovací dotaz, který se spustí při spuštění kontroly stavu, aby se otestoval stav připojení k databázi a konfigurace.

Návraty

IHealthChecksBuilder

Hodnota IHealthChecksBuilder

Poznámky

Implementace kontroly stavu přidaná touto metodou použije kontejner injektáže závislostí k vytvoření instance TContext.

Ve výchozím nastavení implementace kontroly stavu použije metodu k CanConnectAsync(CancellationToken) otestování připojení k databázi. Tato metoda vyžaduje, aby poskytovatel databáze správně implementoval IDatabaseCreator rozhraní. Pokud poskytovatel databáze toto rozhraní neimplementoval, kontrola stavu nahlásí selhání.

Poskytnutí nahradí customTestQuery použití k CanConnectAsync(CancellationToken) otestování připojení k databázi. Implementace testovacího dotazu by měla zpracovávat výjimky, ke kterým může dojít v důsledku selhání připojení, a měla by vrátit výsledek úspěšného/neúspěšného výsledku. Testovací dotaz by měl být navržený tak, aby se dokončil v krátkém a predikovatelném čase.