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? charset? collation? connection_retry_count? database hide_unknown_error? host? implicit_apply_schemas? is_default? logger? max_lifetime? password? pool_idle_timeout? pool_max_idle? pool_size? port? query_timeout? reconnect_if_read_only? redis_cache? replication? ssl? user?

Properties

OptionalauthPlugins

authPlugins?: {
    [plugin: string]: (({ connection, command }: {
        command: any;
        connection: any;
    }) => ((data: any) => Buffer));
}

Optionalcharset

charset?: string

Optionalcollation

collation?: string

Optionalconnection_retry_count

connection_retry_count?: number

database

database: string

Optionalhide_unknown_error

hide_unknown_error?: boolean

Optionalhost

host?: string

Optionalimplicit_apply_schemas

implicit_apply_schemas?: boolean

Optionalis_default

is_default?: boolean

Optionallogger

logger?:
    | "console"
    | "color-console"
    | "empty"
    | Logger

Optionalmax_lifetime

max_lifetime?: number

Optionalpassword

password?: string | Promise<string>

Optionalpool_idle_timeout

pool_idle_timeout?: number

Optionalpool_max_idle

pool_max_idle?: number

Optionalpool_size

pool_size?: number

Optionalport

port?: number

Optionalquery_timeout

query_timeout?: number

Optionalreconnect_if_read_only

reconnect_if_read_only?: boolean

Optionalredis_cache

redis_cache?: RedisCacheSettings

Optionalreplication

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;
}

Optionalssl

ssl?: string | SecureContextOptions & {
    rejectUnauthorized?: boolean;
}

Optionaluser

user?: string | Promise<string>

Settings

Member Visibility

On This Page

Properties