EntityFrameworkCoreHealthChecksBuilderExtensions.AddDbContextCheck<TContext> 메서드
정의
중요
일부 정보는 릴리스되기 전에 상당 부분 수정될 수 있는 시험판 제품과 관련이 있습니다. Microsoft는 여기에 제공된 정보에 대해 어떠한 명시적이거나 묵시적인 보증도 하지 않습니다.
지정된 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형식 매개 변수
- TContext
DbContext 형식입니다.
매개 변수
- builder
- IHealthChecksBuilder
- name
- String
상태 검사 이름입니다. Optional. 이름에 형식 이름을 TContext 사용할 경우 null
- failureStatus
- Nullable<HealthStatus>
HealthStatus 상태 검사가 실패할 때 보고해야 하는 것입니다. Optional. 이 경우 null 기본 상태가 Unhealthy 보고됩니다.
- tags
- IEnumerable<String>
상태 검사 집합을 필터링하는 데 사용할 수 있는 태그 목록입니다. Optional.
- customTestQuery
- Func<TContext,CancellationToken,Task<Boolean>>
상태 검사가 실행되어 데이터베이스 연결 및 구성의 상태를 테스트할 때 실행되는 사용자 지정 테스트 쿼리입니다.
반품
설명
이 메서드에 의해 추가된 상태 검사 구현은 종속성 주입 컨테이너를 사용하여 인스턴스 TContext를 만듭니다.
기본적으로 상태 검사 구현은 이 메서드를 CanConnectAsync(CancellationToken) 사용하여 데이터베이스에 대한 연결을 테스트합니다. 이 메서드를 사용하려면 데이터베이스 공급자가 인터페이스를 올바르게 구현해야 합니다 IDatabaseCreator . 데이터베이스 공급자가 이 인터페이스를 구현하지 않은 경우 상태 검사에서 오류를 보고합니다.
제공하면 customTestQuery 데이터베이스 연결을 테스트하는 데 사용하는 CanConnectAsync(CancellationToken) 것이 대체됩니다. 테스트 쿼리의 구현은 연결 실패로 인해 발생할 수 있는 예외를 처리해야 하며 통과/실패 결과를 반환해야 합니다. 테스트 쿼리는 짧고 예측 가능한 시간 안에 완료되도록 설계되어야 합니다.
