@storehouse/pg - v2.0.0
    Preparing search index...

    Interface PgHealthCheckResult

    Extended health check result specific to PostgreSQL managers. Includes connection pool metrics and query response time.

    interface PgHealthCheckResult {
        details: {
            ended?: boolean;
            error?: string;
            idleCount?: number;
            latency?: string;
            name: string;
            totalCount?: number;
            waitingCount?: number;
            [key: string]: unknown;
        };
        healthy: boolean;
        latency?: number;
        message?: string;
        timestamp: number;
    }

    Hierarchy

    • HealthCheckResult
      • PgHealthCheckResult
    Index

    Properties

    details healthy latency? message? timestamp

    Properties

    details: {
        ended?: boolean;
        error?: string;
        idleCount?: number;
        latency?: string;
        name: string;
        totalCount?: number;
        waitingCount?: number;
        [key: string]: unknown;
    }

    Detailed information about the PostgreSQL connection pool health.

    Type Declaration

    • [key: string]: unknown

      Additional custom properties

    • Optionalended?: boolean

      Indicates whether the connection pool has ended

    • Optionalerror?: string

      Error message or stack trace if the health check failed

    • OptionalidleCount?: number

      Number of clients currently idle in the pool

    • Optionallatency?: string

      Time taken to perform the health check query in milliseconds

    • name: string

      The name of the manager

    • OptionaltotalCount?: number

      Total number of clients in the pool

    • OptionalwaitingCount?: number

      Number of clients currently waiting for a connection

    healthy: boolean

    Whether the connection is healthy

    latency?: number

    Response time in milliseconds

    message?: string

    Human-readable status message

    timestamp: number

    Unix timestamp when the check was performed

    Settings

    Member Visibility

    On This Page

    Properties