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
正常性チェック名前。 このフィールドは省略可能です。
null場合は、TContextの型名が名前に使用されます。
- failureStatus
- Nullable<HealthStatus>
正常性チェックが失敗したときに報告する必要がある HealthStatus 。 このフィールドは省略可能です。
null場合、Unhealthyの既定の状態が報告されます。
- tags
- IEnumerable<String>
正常性チェックのセットをフィルター処理するために使用できるタグの一覧。 このフィールドは省略可能です。
- customTestQuery
- Func<TContext,CancellationToken,Task<Boolean>>
データベース接続と構成の正常性をテストするために正常性チェックが実行されるときに実行されるカスタム テスト クエリ。
返品
注釈
このメソッドによって追加された正常性チェックの実装では、依存関係挿入コンテナーを使用して TContextのインスタンスが作成されます。
既定では、正常性チェックの実装では、 CanConnectAsync(CancellationToken) メソッドを使用してデータベースへの接続をテストします。 このメソッドでは、データベース プロバイダーが IDatabaseCreator インターフェイスを正しく実装している必要があります。 データベース プロバイダーがこのインターフェイスを実装していない場合、正常性チェックでエラーが報告されます。
customTestQueryを指定すると、データベース接続をテストするためのCanConnectAsync(CancellationToken)の使用が置き換えられます。 テスト クエリの実装では、接続エラーが原因で発生する可能性がある例外を処理し、合格/失敗の結果を返す必要があります。 テスト クエリは、短時間で予測可能な時間で完了するように設計する必要があります。
