EntityFrameworkCoreHealthChecksBuilderExtensions.AddDbContextCheck<TContext> Metoda

Definicja

Przestrzeń nazw:

Microsoft.Extensions.DependencyInjection

Zestaw:

Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore.dll

Pakiet:

Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore v8.0.6

Źródło:

EntityFrameworkCoreHealthChecksBuilderExtensions.cs

Dodaje kontrolę kondycji dla określonego DbContext typu.

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

Element IHealthChecksBuilder.

name

String

Nazwa kontroli kondycji. Opcjonalny. Jeśli null nazwa typu będzie TContext używana dla nazwy.

failureStatus

Nullable<HealthStatus>

Należy HealthStatus je zgłosić, gdy sprawdzanie kondycji zakończy się niepowodzeniem. Opcjonalny. Jeśli null zostanie zgłoszony domyślny stan Unhealthy .

tags

IEnumerable<String>

Lista tagów, których można użyć do filtrowania zestawów kontroli kondycji. Opcjonalny.

customTestQuery

Func<TContext,CancellationToken,Task<Boolean>>

Niestandardowe zapytanie testowe, które zostanie wykonane po wykonaniu kontroli kondycji w celu przetestowania kondycji połączenia i konfiguracji bazy danych.

Zwraca

IHealthChecksBuilder

Element IHealthChecksBuilder.

Uwagi

Implementacja sprawdzania kondycji dodana przez tę metodę użyje kontenera iniekcji zależności, aby utworzyć wystąpienie klasy TContext.

Domyślnie implementacja kontroli kondycji będzie używać CanConnectAsync(CancellationToken) metody do testowania łączności z bazą danych. Ta metoda wymaga poprawnego zaimplementowania interfejsu przez dostawcę IDatabaseCreator bazy danych. Jeśli dostawca bazy danych nie zaimplementował tego interfejsu, kontrola kondycji zgłosi błąd.

Podanie elementu customTestQuery spowoduje zastąpienie użycia do testowania CanConnectAsync(CancellationToken) łączności z bazą danych. Implementacja zapytania testowego powinna obsługiwać wyjątki, które mogą wystąpić z powodu awarii łączności i powinny zwrócić wynik przebiegu/niepowodzenia. Zapytanie testowe powinno być zaprojektowane tak, aby zostało ukończone w krótkim i niepewnym czasie.