EntityFrameworkCoreHealthChecksBuilderExtensions.AddDbContextCheck<TContext> Methode
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Fügt eine Integritätsprüfung für den angegebenen DbContext Typ hinzu.
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 IHealthChecksBuilderTypparameter
- TContext
Der DbContext-Typ.
Parameter
- builder
- IHealthChecksBuilder
Die IHealthChecksBuilder.
- name
- String
Der Name der Integritätsprüfung. Dies ist optional. Wenn null der Typname TContext für den Namen verwendet wird.
- failureStatus
- Nullable<HealthStatus>
Dies HealthStatus sollte gemeldet werden, wenn die Integritätsprüfung fehlschlägt. Dies ist optional. Wenn null dann der Standardstatus Unhealthy gemeldet wird.
- tags
- IEnumerable<String>
Eine Liste von Tags, die zum Filtern von Integritätsprüfungen verwendet werden können. Dies ist optional.
- customTestQuery
- Func<TContext,CancellationToken,Task<Boolean>>
Eine benutzerdefinierte Testabfrage, die ausgeführt wird, wenn die Integritätsprüfung ausgeführt wird, um den Status der Datenbankverbindung und -konfigurationen zu testen.
Gibt zurück
Die IHealthChecksBuilder.
Hinweise
Die von dieser Methode hinzugefügte Implementierung der Integritätsprüfung verwendet den Container zum Einfügen von Abhängigkeiten, um eine Instanz von TContext.
Standardmäßig verwendet die Implementierung der Integritätsprüfung die CanConnectAsync(CancellationToken) Methode, um die Verbindung mit der Datenbank zu testen. Für diese Methode muss der Datenbankanbieter die IDatabaseCreator Schnittstelle ordnungsgemäß implementiert haben. Wenn der Datenbankanbieter diese Schnittstelle nicht implementiert hat, meldet die Integritätsprüfung einen Fehler.
Durch die Bereitstellung wird customTestQuery die Verwendung der CanConnectAsync(CancellationToken) Datenbankkonnektivität ersetzt. Eine Implementierung einer Testabfrage sollte Ausnahmen behandeln, die aufgrund eines Konnektivitätsfehlers auftreten können, und ein Pass-/Fail-Ergebnis zurückgeben. Die Testabfrage sollte so konzipiert sein, dass sie in kurzer und vordefinierter Zeit abgeschlossen werden kann.
