Documentation
    Preparing search index...

    Interface PoolOptions<Dialect>

    Connection Pool options.

    Used in SequelizeCoreOptions.pool

    interface PoolOptions<Dialect extends AbstractDialect> {
        acquire?: number;
        evict?: number;
        idle?: number;
        max?: number;
        maxUses?: number;
        min?: number;
        validate?: (connection?: Connection<Dialect>) => boolean;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index
    acquire? evict? idle? max? maxUses? min? validate?
    acquire?: number

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

    evict?: number

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

    idle?: number

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

    max?: number

    Maximum number of connections in pool. Default is 5

    maxUses?: number

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

    min?: number

    Minimum number of connections in pool. Default is 0

    validate?: (connection?: Connection<Dialect>) => boolean

    A function that validates a connection.

    If provided, this overrides the default connection validation built in to sequelize.

    Settings
    Member Visibility

    On This Page
    Properties