EntityFrameworkCoreHealthChecksBuilderExtensions.AddDbContextCheck<TContext> メソッド

定義

名前空間:

Microsoft.Extensions.DependencyInjection

アセンブリ:

Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore.dll

パッケージ:

Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore v8.0.0

ソース:

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

正常性チェック名。 省略可能。 の型名TContextが名前に使用される場合null。

failureStatus

Nullable<HealthStatus>

HealthStatus正常性チェックが失敗したときに報告する必要がある 。 省略可能。 その場合 null は、 の既定の Unhealthy 状態が報告されます。

tags

IEnumerable<String>

正常性チェックのセットをフィルター処理するために使用できるタグの一覧。 省略可能。

customTestQuery

Func<TContext,CancellationToken,Task<Boolean>>

正常性チェックが実行され、データベース接続と構成の正常性をテストするときに実行されるカスタム テスト クエリ。

戻り値

IHealthChecksBuilder

IHealthChecksBuilder。

注釈

このメソッドによって追加された正常性チェック実装では、依存関係挿入コンテナーを使用して のTContextインスタンスが作成されます。

既定では、正常性チェック実装では、 メソッドをCanConnectAsync(CancellationToken)使用してデータベースへの接続をテストします。 このメソッドでは、データベース プロバイダーがインターフェイスを正しく実装している IDatabaseCreator 必要があります。 データベース プロバイダーがこのインターフェイスを実装していない場合、正常性チェックはエラーを報告します。

を customTestQuery 指定すると、 を使用 CanConnectAsync(CancellationToken) してデータベース接続をテストできます。 テスト クエリの実装では、接続エラーが原因で発生する可能性がある例外を処理し、合格/失敗の結果を返す必要があります。 テスト クエリは、短時間で実現可能な時間で完了するように設計する必要があります。