EntityFrameworkCoreHealthChecksBuilderExtensions.AddDbContextCheck<TContext> Metode

Definisi

Ruang nama:

Microsoft.Extensions.DependencyInjection

Rakitan:

Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore.dll

Paket:

Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore v8.0.6

Sumber:

EntityFrameworkCoreHealthChecksBuilderExtensions.cs

Menambahkan pemeriksaan kesehatan untuk jenis yang ditentukan 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

Jenis parameter

TContext

Jenisnya adalah DbContext.

Parameter

builder

IHealthChecksBuilder

IHealthChecksBuilder.

name

String

Nama pemeriksaan kesehatan. Pilihan. Jika null nama jenis TContext akan digunakan untuk nama tersebut.

failureStatus

Nullable<HealthStatus>

HealthStatus yang harus dilaporkan ketika pemeriksaan kesehatan gagal. Pilihan. Jika null kemudian status Unhealthy default akan dilaporkan.

tags

IEnumerable<String>

Daftar tag yang dapat digunakan untuk memfilter kumpulan pemeriksaan kesehatan. Pilihan.

customTestQuery

Func<TContext,CancellationToken,Task<Boolean>>

Kueri pengujian kustom yang akan dijalankan saat pemeriksaan kesehatan dijalankan untuk menguji kesehatan koneksi dan konfigurasi database.

Mengembalikan

IHealthChecksBuilder

IHealthChecksBuilder.

Keterangan

Implementasi pemeriksaan kesehatan yang ditambahkan oleh metode ini akan menggunakan kontainer injeksi dependensi untuk membuat instans TContext.

Secara default implementasi pemeriksaan kesehatan akan menggunakan CanConnectAsync(CancellationToken) metode untuk menguji konektivitas ke database. Metode ini mengharuskan penyedia database telah menerapkan IDatabaseCreator antarmuka dengan benar. Jika penyedia database belum menerapkan antarmuka ini, maka pemeriksaan kesehatan akan melaporkan kegagalan.

Menyediakan customTestQuery akan menggantikan penggunaan CanConnectAsync(CancellationToken) untuk menguji konektivitas database. Implementasi kueri pengujian harus menangani pengecualian yang dapat muncul karena kegagalan konektivitas, dan harus mengembalikan hasil lulus/gagal. Kueri pengujian harus dirancang untuk diselesaikan dalam waktu singkat dan dapat diprediksi.