Interface PostgresPoolLike

The part of pg's Pool the adapter uses. A Pool from pg is one; so is any object with these members.

interface PostgresPoolLike {
    query(text: string, values?: unknown[]): Promise<PostgresQueryResultLike>;
    connect(): Promise<PostgresPoolClientLike>;
    end(): Promise<void>;
    on?(event: "error", listener: ((error: Error) => void)): unknown;
    removeListener?(event: "error", listener: ((error: Error) => void)): unknown;
    ending?: boolean;
    ended?: boolean;
    totalCount?: number;
    idleCount?: number;
    waitingCount?: number;
}

Properties

ending? ended? totalCount? idleCount? waitingCount?

Methods

query connect end on? removeListener?

Properties

Optional Readonlyending

ending?: boolean

True once end() has been called; pg's Pool sets it.

Optional Readonlyended

ended?: boolean

True once the pool has ended; pg's Pool sets it.

Optional ReadonlytotalCount

totalCount?: number

Connections the pool holds, checked out or idle; pg's Pool counts them.

Optional ReadonlyidleCount

idleCount?: number

Connections idle in the pool.

Optional ReadonlywaitingCount

waitingCount?: number

Callers waiting for a connection.

Methods

query

connect

end

Optionalon

  • on(event, listener): unknown

  • Parameters

    • event: "error"
    • listener: ((error: Error) => void)
        • (error): void

        • Parameters

          • error: Error

          Returns void

    Returns unknown

OptionalremoveListener

  • removeListener(event, listener): unknown

  • Parameters

    • event: "error"
    • listener: ((error: Error) => void)
        • (error): void

        • Parameters

          • error: Error

          Returns void

    Returns unknown

Settings

Member Visibility

On This Page

Properties
Methods