EntityFrameworkCoreHealthChecksBuilderExtensions.AddDbContextCheck<TContext> Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Добавляет проверку работоспособности указанного 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.
Комментарии
Реализация проверки работоспособности, добавленная этим методом, будет использовать контейнер внедрения зависимостей для создания экземпляра TContext.
По умолчанию реализация проверки работоспособности будет использовать CanConnectAsync(CancellationToken) метод для проверки подключения к базе данных. Этот метод требует, чтобы поставщик базы данных правильно реализовал IDatabaseCreator интерфейс. Если поставщик базы данных не реализовал этот интерфейс, проверка работоспособности сообщит о сбое.
customTestQuery Предоставление замены использования CanConnectAsync(CancellationToken) для проверки подключения к базе данных. Реализация тестового запроса должна обрабатывать исключения, которые могут возникать из-за сбоя подключения и возвращать результат передачи или сбоя. Тестовый запрос должен быть разработан для выполнения в короткий и предикатируемый период времени.
