Interface MysqlDialectConfig

Config for the MySQL dialect.

interface MysqlDialectConfig {
    controlConnection?: (config: object) => MysqlConnection;
    onCreateConnection?: (
        connection: DatabaseConnection,
        options?: AbortableOperationOptions,
    ) => Promise<void>;
    onReserveConnection?: (
        connection: DatabaseConnection,
        options?: AbortableOperationOptions,
    ) => Promise<void>;
    pool:
        | MysqlPool
        | ((options?: AbortableOperationOptions) => Promise<MysqlPool>);
}

Properties

controlConnection?: (config: object) => MysqlConnection

A mysql2 Client constructor, to be used for connecting to the database outside of the pool to avoid waiting for an idle connection.

This is useful for cancelling queries on the database side.

onCreateConnection?: (
connection: DatabaseConnection,
options?: AbortableOperationOptions,
) => Promise<void>

Called once for each created connection.

onReserveConnection?: (
connection: DatabaseConnection,
options?: AbortableOperationOptions,
) => Promise<void>

Called every time a connection is acquired from the pool.

A mysql2 Pool instance or a function that returns one.

If a function is provided, it's called once when the first query is executed.