EntityFrameworkCoreHealthChecksBuilderExtensions.AddDbContextCheck<TContext> Método
Definição
Importante
Algumas informações dizem respeito a um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado. A Microsoft não faz garantias, de forma expressa ou implícita, em relação à informação aqui apresentada.
Adiciona um exame de saúde para o tipo especificado 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 IHealthChecksBuilderParâmetros de Tipo Genérico
- TContext
O DbContext tipo.
Parâmetros
- builder
- IHealthChecksBuilder
- name
- String
O nome da verificação de estado de funcionamento. Optional. Se null o nome do tipo for TContext usado para o nome.
- failureStatus
- Nullable<HealthStatus>
Isso HealthStatus deve ser reportado quando o exame de saúde falhar. Optional. Se null então, o estado padrão de Unhealthy será reportado.
- tags
- IEnumerable<String>
Uma lista de etiquetas que podem ser usadas para filtrar conjuntos de verificações de saúde. Optional.
- customTestQuery
- Func<TContext,CancellationToken,Task<Boolean>>
Uma consulta de teste personalizada que será executada quando a verificação de estado for executada para testar a saúde da ligação à base de dados e das suas configurações.
Devoluções
Observações
A implementação de verificação de saúde adicionada por este método usará o contentor de injeção de dependências para criar uma instância de TContext.
Por defeito, a implementação da verificação de estado usará o CanConnectAsync(CancellationToken) método para testar a conectividade à base de dados. Este método exige que o fornecedor da base de dados tenha implementado corretamente a IDatabaseCreator interface. Se o fornecedor da base de dados não tiver implementado esta interface, a verificação de saúde irá reportar uma falha.
Fornecer um customTestQuery substituirá o uso de CanConnectAsync(CancellationToken) para testar a conectividade da base de dados. Uma implementação de uma consulta de teste deve tratar exceções que possam surgir devido a falha de conectividade e deve devolver um resultado de aprovação/reprovação. A consulta de teste deve ser concebida para ser concluída num curto espaço de tempo previsível.
