Class ApplicationDatabaseHealthCheck

Namespace

ProjectTemplate.Web.HealthChecks

Assembly

ProjectTemplate.Web.dll

Reports whether the application database accepts connections.

public sealed class ApplicationDatabaseHealthCheck : IHealthCheck

Inheritance

object

ApplicationDatabaseHealthCheck

Implements

IHealthCheck

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Registered with the Ready tag so an instance that cannot reach its database is removed from load balancing. The result description never includes connection strings or provider exception text. For SQLite, a database file that has not been created yet is reported as unavailable. When DatabaseReadinessCheckEnabled is false, the check reports healthy without contacting the database.

Constructors

ApplicationDatabaseHealthCheck(IServiceScopeFactory, IOptionsMonitor<ApplicationHealthCheckOptions>)

Reports whether the application database accepts connections.

public ApplicationDatabaseHealthCheck(IServiceScopeFactory scopeFactory, IOptionsMonitor<ApplicationHealthCheckOptions> options)

Parameters

scopeFactory IServiceScopeFactory

options IOptionsMonitor<ApplicationHealthCheckOptions>

Remarks

Registered with the Ready tag so an instance that cannot reach its database is removed from load balancing. The result description never includes connection strings or provider exception text. For SQLite, a database file that has not been created yet is reported as unavailable. When DatabaseReadinessCheckEnabled is false, the check reports healthy without contacting the database.

Methods

CheckHealthAsync(HealthCheckContext, CancellationToken)

Checks whether the application database accepts connections.

public Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context, CancellationToken cancellationToken = default)

Parameters

context HealthCheckContext

The health check context.

cancellationToken CancellationToken

A token that cancels the check.

Returns

Task<HealthCheckResult>

The database health result.