EntityFrameworkCoreHealthChecksBuilderExtensions.AddDbContextCheck<TContext> Método

Definição

Namespace:

Microsoft.Extensions.DependencyInjection

Assembly:

Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore.dll

Pacote:

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

Origem:

EntityFrameworkCoreHealthChecksBuilderExtensions.cs

Adiciona uma marcar de integridade para o tipo especificadoDbContext.

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

Parâmetros de tipo

TContext

O tipo DbContext.

Parâmetros

builder

IHealthChecksBuilder

O IHealthChecksBuilder.

name

String

O nome da verificação de integridade. Opcional. Se null o nome do tipo de TContext for usado para o nome.

failureStatus

Nullable<HealthStatus>

O HealthStatus que deve ser relatado quando a marcar de integridade falhar. Opcional. Senull, em seguida, o status padrão de Unhealthy será relatado.

tags

IEnumerable<String>

Uma lista de marcas que podem ser usadas para filtrar conjuntos de verificações de integridade. Opcional.

customTestQuery

Func<TContext,CancellationToken,Task<Boolean>>

Uma consulta de teste personalizada que será executada quando o marcar de integridade for executado para testar a integridade da conexão e das configurações do banco de dados.

Retornos

IHealthChecksBuilder

O IHealthChecksBuilder.

Comentários

A implementação de marcar de integridade adicionada por esse método usará o contêiner de injeção de dependência para criar uma instância do TContext.

Por padrão, a implementação do marcar de integridade usará o CanConnectAsync(CancellationToken) método para testar a conectividade com o banco de dados. Esse método exige que o provedor de banco de dados tenha implementado corretamente a IDatabaseCreator interface. Se o provedor de banco de dados não tiver implementado essa interface, o marcar de integridade relatará uma falha.

Fornecer um customTestQuery substituirá o uso de para testar a conectividade do banco de CanConnectAsync(CancellationToken) dados. Uma implementação de uma consulta de teste deve tratar exceções que podem surgir devido a uma falha de conectividade e deve retornar um resultado de aprovação/falha. A consulta de teste deve ser projetada para ser concluída em um período curto e predicado.