Interface PoolOptions

Connection Pool options.

Used in Options.pool

interface PoolOptions {
    acquire?: number;
    evict?: number;
    idle?: number;
    max?: number;
    maxUses?: number;
    min?: number;
    validate?(client?): boolean;
}

Properties

acquire? evict? idle? max? maxUses? min?

Methods

validate?

Properties

Optional acquire

acquire?: number

The maximum time, in milliseconds, that pool will try to get connection before throwing error

Optional evict

evict?: number

The time interval, in milliseconds, after which sequelize-pool will remove idle connections.

Optional idle

idle?: number

The maximum time, in milliseconds, that a connection can be idle before being released

Optional max

max?: number

Maximum number of connections in pool. Default is 5

Optional maxUses

maxUses?: number

The number of times to use a connection before closing and replacing it. Default is Infinity

Optional min

min?: number

Minimum number of connections in pool. Default is 0

Methods

Optional validate

  • validate(client?): boolean

  • A function that validates a connection. Called with client. The default function checks that client is an object, and that its state is not disconnected

    Parameters

    • Optional client: unknown

    Returns boolean

Settings

Member Visibility

Theme

On This Page

acquireevictidlemaxmaxUsesminvalidate

Generated using TypeDoc