Interface MySQLConnectionSettings

interface MySQLConnectionSettings {
    authPlugins?: {
        [plugin: string]: (({ connection, command }) => ((data) => 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?: Logger | "console" | "color-console" | "empty";
    password?: string | Promise<string>;
    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_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 }) => ((data) => Buffer));
}

Type declaration

  • [plugin: string]: (({ connection, command }) => ((data) => Buffer))
      • ({ connection, command }): ((data) => Buffer)
      • Parameters

        • { connection, command }: {
              command: any;
              connection: any;
          }
          • command: any
          • connection: any

        Returns ((data) => Buffer)

          • (data): Buffer
          • Parameters

            • data: any

            Returns 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?: Logger | "console" | "color-console" | "empty"
password?: string | Promise<string>
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_size?: number;
        port?: number;
        user?: string | Promise<string>;
    }[];
    use_master_for_read?: boolean;
}

Type declaration

  • read_replicas: {
        host?: string;
        password?: string | Promise<string>;
        pool_size?: number;
        port?: number;
        user?: string | Promise<string>;
    }[]
  • Optional use_master_for_read?: boolean
ssl?: string | SecureContextOptions & {
    rejectUnauthorized?: boolean;
}
user?: string | Promise<string>

Generated using TypeDoc