Interface MySQLAdapterOptions

mysql2 Pool options plus Toshihiko Adapter configuration.

interface MySQLAdapterOptions {
    cache?: CacheSource;
    database?: string;
    package?: string;
    password?: string;
    pool?: Pool;
    showSql?: MySQLShowSql;
    user?: string;
    username?: string;
}

Hierarchy

Omit<PoolOptions, "database" | "password" | "user">
- MySQLAdapterOptions

Index

Properties

cache? database? package? password? pool? showSql? user? username?

Properties

`Optional` `Readonly`cache

cache?: CacheSource

Cache instance or module-style Cache configuration.

`Optional` `Readonly`database

database?: string

Database name; defaults to toshihiko.

`Optional` `Readonly`package

package?: string

Driver package name retained for compatibility.

`Optional` `Readonly`password

password?: string

MySQL password.

`Optional` `Readonly`pool

pool?: Pool

Existing mysql2 Pool.

`Optional` `Readonly`showSql

showSql?: MySQLShowSql

SQL logging behavior.

`Optional` `Readonly`user

user?: string

MySQL username.

`Optional` `Readonly`username

username?: string

Compatibility alias for user.