Skip to main content

Interface: DbHealthResult

Defined in: src/context/DbContext.ts:26

Diagnostic health status object returned by context.health().

Properties​

connected​

connected: boolean

Defined in: src/context/DbContext.ts:28

Indicates whether the database heartbeat succeeded.


latencyMs​

latencyMs: number

Defined in: src/context/DbContext.ts:30

Round-trip ping/version query latency in milliseconds.


provider​

provider: DbProvider

Defined in: src/context/DbContext.ts:32

Active database provider dialect identifier (e.g. 'postgres', 'sqlite', 'mssql').


serverVersion?​

optional serverVersion?: string

Defined in: src/context/DbContext.ts:34

Database server version string if queryable.


error?​

optional error?: string

Defined in: src/context/DbContext.ts:36

Error message if connectivity check failed.