EntityFrameworkCoreHealthChecksBuilderExtensions.AddDbContextCheck<TContext> Metodo

Definizione

Spazio dei nomi:

Microsoft.Extensions.DependencyInjection

Assembly:

Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore.dll

Pacchetto:

Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore v8.0.4

Origine:

EntityFrameworkCoreHealthChecksBuilderExtensions.cs

Aggiunge un controllo di integrità per il tipo specificato DbContext .

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

Parametri di tipo

TContext

Tipo DbContext.

Parametri

builder

IHealthChecksBuilder

Oggetto IHealthChecksBuilder.

name

String

Nome del controllo integrità. facoltativo. Se null il nome del tipo di TContext verrà usato per il nome.

failureStatus

Nullable<HealthStatus>

Oggetto HealthStatus che deve essere segnalato quando il controllo di integrità ha esito negativo. facoltativo. Se null lo stato predefinito di Unhealthy verrà segnalato.

tags

IEnumerable<String>

Elenco di tag che possono essere usati per filtrare i set di controlli di integrità. facoltativo.

customTestQuery

Func<TContext,CancellationToken,Task<Boolean>>

Query di test personalizzata che verrà eseguita quando viene eseguito il controllo integrità per testare l'integrità della connessione e delle configurazioni del database.

Restituisce

IHealthChecksBuilder

Oggetto IHealthChecksBuilder.

Commenti

L'implementazione del controllo integrità aggiunta da questo metodo userà il contenitore di inserimento delle dipendenze per creare un'istanza di TContext.

Per impostazione predefinita, l'implementazione del controllo integrità userà il metodo per testare la CanConnectAsync(CancellationToken) connettività al database. Questo metodo richiede che il provider di database abbia implementato correttamente l'interfaccia IDatabaseCreator . Se il provider di database non ha implementato questa interfaccia, il controllo integrità segnala un errore.

Fornendo un customTestQuery oggetto sostituirà l'uso di CanConnectAsync(CancellationToken) per testare la connettività del database. Un'implementazione di una query di test deve gestire le eccezioni che possono verificarsi a causa di un errore di connettività e deve restituire un risultato pass/fail. La query di test deve essere progettata per completare in un intervallo di tempo breve e predicabile.