Documentation CLI 0.1.1 · development llms.txt

coldctl source add mysql

Configure a MySQL source.

ImplementedLocal configuration

Syntax

USAGE

coldctl source add mysql [OPTIONS] --name <NAME> <--url <URL>|--url-env <URL_ENV>>

Arguments & options

Option	Description / default
`--data-dir <PATH>`	Override the OS application data directory
`--name <NAME>`	Unique local source name (ASCII letters, digits, hyphens, underscores)
`--output <OUTPUT>`	Output format; JSON contains no resolved credentials [default: table] [possible values: table, json]
`--tls-ca-env <TLS_CA_ENV>`	Environment variable containing a PEM CA bundle for PostgreSQL/MySQL/MongoDB certificate validation
`--url <URL>`	Password-free postgres://, mysql:// or mongodb:// URL; supports sslmode=require\|disable
`--url-env <URL_ENV>`	Name of an environment variable holding the full URL; its value is never stored
`--password-env <PASSWORD_ENV>`	Name of an environment variable holding the password, resolved only when connecting
`-h, --help`	Print help

Examples

Replace configuration names, paths and JOB_ID with values from your installation. Examples are not executed by this page.

CLI

coldctl source add mysql --name mysql-source --url mysql://archive_reader@db.example.com/app --password-env DATABASE_PASSWORD --tls-ca-env DATABASE_CA_PEM

Operational notes

Adds configuration without connecting. Use the matching approved connector. --tls-ca-env references PEM certificate text. Exactly one URL mode is required; never put a password in --url.

Output, placeholders & global flags

View exact CLI help

HELP OUTPUT

Configure one MySQL TCP endpoint. TLS is required by default

Usage: coldctl source add mysql [OPTIONS] --name <NAME> <--url <URL>|--url-env <URL_ENV>>

Options:
      --data-dir <PATH>              Override the OS application data directory
      --name <NAME>                  Unique local source name (ASCII letters, digits, hyphens, underscores)
      --output <OUTPUT>              Output format; JSON contains no resolved credentials [default: table] [possible values: table, json]
      --tls-ca-env <TLS_CA_ENV>      Environment variable containing a PEM CA bundle for PostgreSQL/MySQL/MongoDB certificate validation
      --url <URL>                    Password-free postgres://, mysql:// or mongodb:// URL; supports sslmode=require|disable
      --url-env <URL_ENV>            Name of an environment variable holding the full URL; its value is never stored
      --password-env <PASSWORD_ENV>  Name of an environment variable holding the password, resolved only when connecting
  -h, --help                         Print help