EntityFrameworkCoreHealthChecksBuilderExtensions.AddDbContextCheck<TContext> Метод

Определение

Пространство имен:

Microsoft.Extensions.DependencyInjection

Сборка:

Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore.dll

Пакет:

Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore v9.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

Имя проверки работоспособности. Необязательный элемент. Значение , если 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) для проверки подключения к базе данных. Реализация тестового запроса должна обрабатывать исключения, которые могут возникнуть из-за сбоя подключения, и возвращать результат прохождения или сбоя. Тестовый запрос должен быть разработан таким образом, чтобы выполнить его за короткий и предикатируемый промежуток времени.