Interface PdoPoolOptions

interface PdoPoolOptions {
    acquireTimeoutMillis?: number;
    acquired?: ((uuid, eventId) => void);
    createRetryIntervalMillis?: number;
    createTimeoutMillis?: number;
    created?: ((uuid, connection) => void | Promise<void>);
    destroyTimeoutMillis?: number;
    destroyed?: ((uuid) => void | Promise<void>);
    idleTimeoutMillis?: number;
    killResource?: boolean;
    killTimeoutMillis?: number;
    killed?: ((uuid) => void);
    max?: number;
    min?: number;
    reapIntervalMillis?: number;
    released?: ((uuid) => void);
}

Properties

acquireTimeoutMillis? acquired? createRetryIntervalMillis? createTimeoutMillis? created? destroyTimeoutMillis? destroyed? idleTimeoutMillis? killResource? killTimeoutMillis? killed? max? min? reapIntervalMillis? released?

Properties

Optional acquireTimeoutMillis

acquireTimeoutMillis?: number

acquire promises are rejected after this many milliseconds if a resource cannot be acquired

[Default 10000]

Optional acquired

acquired?: ((uuid, eventId) => void)

Define Custom Acquired Callback.

Type declaration

    • (uuid, eventId): void

    • Parameters

      • uuid: string
      • eventId: number

      Returns void

Optional createRetryIntervalMillis

createRetryIntervalMillis?: number

how long to idle after failed create before trying again

[Default 200]

Optional createTimeoutMillis

createTimeoutMillis?: number

create operations are cancelled after this many milliseconds if a resource cannot be acquired

[Default 5000]

Optional created

created?: ((uuid, connection) => void | Promise<void>)

Define Custom Created Callback. Error on Created Callback will be logged and not raised

Type declaration

    • (uuid, connection): void | Promise<void>

    • Parameters

      Returns void | Promise<void>

Optional destroyTimeoutMillis

destroyTimeoutMillis?: number

destroy operations are awaited for at most this many milliseconds new resources will be created after this timeout

[Default 5000],

Optional destroyed

destroyed?: ((uuid) => void | Promise<void>)

Define Custom Destroyed Callback. Error on Destroyed Callback will be logged and not raised

Type declaration

    • (uuid): void | Promise<void>

    • Parameters

      • uuid: string

      Returns void | Promise<void>

Optional idleTimeoutMillis

idleTimeoutMillis?: number

Free resources are destroyed after this many milliseconds. Note that if min > 0, some resources may be kept alive for longer. To reliably destroy all idle resources, set min to 0.

[Default 30000]

Optional killResource

killResource?: boolean

enable/disable killTimeout

[Default false]

Optional killTimeoutMillis

killTimeoutMillis?: number

when pool destroy is executed connection will be released and brutaly killed after this timeut

[Default 10000].

Optional killed

killed?: ((uuid) => void)

Define Custom Kill Callback.

Type declaration

    • (uuid): void

    • Parameters

      • uuid: string

      Returns void

Optional max

max?: number

maximum pool size

[Default = 10]

Optional min

min?: number

minimum pool size

[Default = 2]

Optional reapIntervalMillis

reapIntervalMillis?: number

how often to check for idle resources to destroy

[Default 500]

Optional released

released?: ((uuid) => void)

Define Custom Release Callback.

Type declaration

    • (uuid): void

    • Parameters

      • uuid: string

      Returns void

Settings

Member Visibility

Theme

On This Page

acquireTimeoutMillisacquiredcreateRetryIntervalMilliscreateTimeoutMilliscreateddestroyTimeoutMillisdestroyedidleTimeoutMilliskillResourcekillTimeoutMilliskilledmaxminreapIntervalMillisreleased