EntityFrameworkCoreHealthChecksBuilderExtensions.AddDbContextCheck<TContext> Yöntem
Tanım
Önemli
Bazı bilgiler ürünün ön sürümüyle ilgilidir ve sürüm öncesinde önemli değişiklikler yapılmış olabilir. Burada verilen bilgilerle ilgili olarak Microsoft açık veya zımni hiçbir garanti vermez.
Belirtilen DbContext tür için bir sistem durumu denetimi ekler.
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
Tür Parametreleri
- TContext
Türü DbContext .
Parametreler
- builder
- IHealthChecksBuilder
- name
- String
Sistem durumu denetimi adı. İsteğe bağlı. Ad için türü TContext
adı kullanılacaksanull
.
- failureStatus
- Nullable<HealthStatus>
Sistem HealthStatus durumu denetimi başarısız olduğunda bildirilmesi gereken. İsteğe bağlı. Bu null
durumda varsayılan durumu Unhealthy bildirilir.
- tags
- IEnumerable<String>
Sistem durumu denetimleri kümelerini filtrelemek için kullanılabilecek etiketlerin listesi. İsteğe bağlı.
- customTestQuery
- Func<TContext,CancellationToken,Task<Boolean>>
Veritabanı bağlantısının ve yapılandırmalarının sistem durumunu test etmek için sistem durumu denetimi yürütürken yürütülecek özel bir test sorgusu.
Döndürülenler
Açıklamalar
Bu yöntem tarafından eklenen sistem durumu denetimi uygulaması, bir örneği oluşturmak için bağımlılık ekleme kapsayıcısını TContext
kullanır.
Varsayılan olarak sistem durumu denetimi uygulaması, veritabanına bağlantıyı test etmek için yöntemini kullanır CanConnectAsync(CancellationToken) . Bu yöntem, veritabanı sağlayıcısının arabirimi doğru şekilde uygulamasını IDatabaseCreator gerektirir. Veritabanı sağlayıcısı bu arabirimi uygulamadıysa sistem durumu denetimi bir hata bildirecektir.
sağlama, customTestQuery
veritabanı bağlantısını test etmek için öğesinin CanConnectAsync(CancellationToken) kullanımını değiştirir. Test sorgusunun uygulanması, bağlantı hatası nedeniyle ortaya çıkabilecek özel durumları işlemeli ve bir geçiş/başarısız sonuç döndürmelidir. Test sorgusu kısa ve önceden ayarlanabilir bir sürede tamamlanacak şekilde tasarlanmalıdır.