Files
wehub-resource-sync e04ed9c211
CF: Deploy Dev Docs / deploy (push) Has been cancelled
Sync Labels / build (push) Has been cancelled
tests / unit tests (macos-latest) (push) Has been cancelled
tests / unit tests (windows-latest) (push) Has been cancelled
tests / unit tests (ubuntu-latest) (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:32:45 +08:00

3.3 KiB

title, linkTitle, type, weight, description, no_list
title linkTitle type weight description no_list
MySQL Source Source docs 1 MySQL is a relational database management system that stores and manages data. true

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

{{< list-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

kind: source
name: my-mysql-source
type: 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

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

Reference

field type required description
type string true Must be "mysql".
host string true IP address to connect to (e.g. "127.0.0.1").
port string true Port to connect to (e.g. "3306").
user string false Name of the MySQL user to connect as (e.g. "my-mysql-user").
password string false Password of the MySQL user (e.g. "my-password").
database string false Name of the MySQL database to connect to (e.g. "my_db").
queryTimeout string false Maximum time to wait for query execution (e.g. "30s", "2m"). By default, no timeout is applied.
queryParams map<string,string> false Arbitrary DSN parameters passed to the driver (e.g. tls: preferred, charset: utf8mb4). Useful for enabling TLS or other connection options.
sqlCommenter boolean false Overrides the global --sql-commenter flag for this source. When set, it takes priority; when omitted, the global flag applies.