Interface MySQLConnectionSettings

interface MySQLConnectionSettings {
    authPlugins?: {
        [plugin: string]: (({ connection, command }: {
            command: any;
            connection: any;
        }) => ((data: any) => Buffer));
    };
    charset?: string;
    collation?: string;
    connection_retry_count?: number;
    database: string;
    hide_unknown_error?: boolean;
    host?: string;
    implicit_apply_schemas?: boolean;
    is_default?: boolean;
    logger?:
        | "console"
        | "color-console"
        | "empty"
        | Logger;
    max_lifetime?: number;
    password?: string | Promise<string>;
    pool_idle_timeout?: number;
    pool_max_idle?: number;
    pool_size?: number;
    port?: number;
    query_timeout?: number;
    reconnect_if_read_only?: boolean;
    redis_cache?: RedisCacheSettings;
    replication?: {
        read_replicas: {
            host?: string;
            password?: string | Promise<string>;
            pool_idle_timeout?: number;
            pool_max_idle?: number;
            pool_size?: number;
            port?: number;
            user?: string | Promise<string>;
        }[];
        use_master_for_read?: boolean;
    };
    ssl?: string | SecureContextOptions & {
        rejectUnauthorized?: boolean;
    };
    user?: string | Promise<string>;
}

Hierarchy

  • ConnectionSettings
  • AdapterSettingsMySQL
    • MySQLConnectionSettings

Properties

authPlugins?: {
    [plugin: string]: (({ connection, command }: {
        command: any;
        connection: any;
    }) => ((data: any) => Buffer));
}
charset?: string
collation?: string
connection_retry_count?: number
database: string
hide_unknown_error?: boolean
host?: string
implicit_apply_schemas?: boolean
is_default?: boolean
logger?:
    | "console"
    | "color-console"
    | "empty"
    | Logger
max_lifetime?: number
password?: string | Promise<string>
pool_idle_timeout?: number
pool_max_idle?: number
pool_size?: number
port?: number
query_timeout?: number
reconnect_if_read_only?: boolean
redis_cache?: RedisCacheSettings
replication?: {
    read_replicas: {
        host?: string;
        password?: string | Promise<string>;
        pool_idle_timeout?: number;
        pool_max_idle?: number;
        pool_size?: number;
        port?: number;
        user?: string | Promise<string>;
    }[];
    use_master_for_read?: boolean;
}
ssl?: string | SecureContextOptions & {
    rejectUnauthorized?: boolean;
}
user?: string | Promise<string>