MySQL

MySQL is a relational database management system that stores and manages data.

About

MySQL is a relational database management system (RDBMS) that stores and manages data. It’s a popular choice for developers because of its reliability, performance, and ease of use.

Available Tools

Requirements

Database User

This source only uses standard authentication. You will need to create a MySQL user to login to the database with.

Example

sources:
    my-mysql-source:
        kind: mysql
        host: 127.0.0.1
        port: 3306
        database: my_db
        user: ${USER_NAME}
        password: ${PASSWORD}
        # Optional TLS and other driver parameters. For example, enable preferred TLS:
        # queryParams:
        #     tls: preferred
        queryTimeout: 30s # Optional: query timeout duration

Tip

Use environment variable replacement with the format ${ENV_NAME} instead of hardcoding your secrets into the configuration file.

Reference

fieldtyperequireddescription
kindstringtrueMust be “mysql”.
hoststringtrueIP address to connect to (e.g. “127.0.0.1”).
portstringtruePort to connect to (e.g. “3306”).
databasestringtrueName of the MySQL database to connect to (e.g. “my_db”).
userstringtrueName of the MySQL user to connect as (e.g. “my-mysql-user”).
passwordstringtruePassword of the MySQL user (e.g. “my-password”).
queryTimeoutstringfalseMaximum time to wait for query execution (e.g. “30s”, “2m”). By default, no timeout is applied.
queryParamsmap<string,string>falseArbitrary DSN parameters passed to the driver (e.g. tls: preferred, charset: utf8mb4). Useful for enabling TLS or other connection options.