EntityFrameworkCoreHealthChecksBuilderExtensions.AddDbContextCheck<TContext> Methode

Definition

Namespace:

Microsoft.Extensions.DependencyInjection

Assembly:

Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore.dll

Paket:

Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore v8.0.0

Quelle:

EntityFrameworkCoreHealthChecksBuilderExtensions.cs

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 IHealthChecksBuilder

Typparameter

TContext

Der DbContext-Typ.

Parameter

builder

IHealthChecksBuilder

Das IHealthChecksBuilder.

name

String

Der Name der Integritätsprüfung. Optional. Wenn null der Typname von TContext für den Namen verwendet wird.

failureStatus

Nullable<HealthStatus>

Die HealthStatus , die gemeldet werden soll, wenn die Integritätsprüfung fehlschlägt. Optional. Wennnull, wird die Standard-status von Unhealthy gemeldet.

tags

IEnumerable<String>

Eine Liste von Tags, die zum Filtern von Sätzen von Integritätsprüfungen verwendet werden können. Optional.

customTestQuery

Func<TContext,CancellationToken,Task<Boolean>>

Eine benutzerdefinierte Testabfrage, die ausgeführt wird, wenn die Integritätsprüfung ausgeführt wird, um die Integrität der Datenbankverbindung und der Konfigurationen zu testen.

Gibt zurück

IHealthChecksBuilder

Das IHealthChecksBuilder.

Hinweise

Die von dieser Methode hinzugefügte Implementierung der Integritätsprüfung verwendet den Dependency Injection-Container, um eine instance von TContextzu erstellen.

Standardmäßig verwendet die Implementierung der Integritätsprüfung die -Methode, um die CanConnectAsync(CancellationToken) Konnektivität mit der Datenbank zu testen. Diese Methode erfordert, dass der Datenbankanbieter die IDatabaseCreator Schnittstelle ordnungsgemäß implementiert hat. Wenn der Datenbankanbieter diese Schnittstelle nicht implementiert hat, meldet die Integritätsprüfung einen Fehler.

Die Angabe von customTestQuery ersetzt die Verwendung von zum Testen der CanConnectAsync(CancellationToken) Datenbankkonnektivität. 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 einer kurzen und voreingestellten Zeit abgeschlossen werden kann.