EntityFrameworkCoreHealthChecksBuilderExtensions.AddDbContextCheck<TContext> 方法

定义

命名空间:

Microsoft.Extensions.DependencyInjection

程序集:

Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore.dll

包:

Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore v8.0.10

Source:

EntityFrameworkCoreHealthChecksBuilderExtensions.cs

为指定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

IHealthChecksBuilder。

name

String

运行状况检查名称。 可选。 如果 null 的类型名称 TContext 将用作名称。

failureStatus

Nullable<HealthStatus>

在HealthStatus运行状况检查失败时应报告的 。 可选。 如果 null ，将报告 的默认 Unhealthy 状态。

tags

IEnumerable<String>

可用于筛选运行状况检查集的标记列表。 可选。

customTestQuery

Func<TContext,CancellationToken,Task<Boolean>>

在运行状况检查执行时将执行的自定义测试查询，用于测试数据库连接和配置的运行状况。

返回

IHealthChecksBuilder

IHealthChecksBuilder。

注解

此方法添加的运行状况检查实现将使用依赖项注入容器来创建 的TContext实例。

默认情况下，运行状况检查实现将使用 CanConnectAsync(CancellationToken) 方法测试与数据库的连接。 此方法要求数据库提供程序已正确实现 IDatabaseCreator 接口。 如果数据库提供程序尚未实现此接口，则运行状况检查将报告失败。

customTestQuery提供 将取代 使用 CanConnectAsync(CancellationToken) 来测试数据库连接。 测试查询的实现应处理因连接失败而可能出现的异常，并且应返回通过/失败结果。 测试查询应设计为在短时间内完成且可谓词的量。