MySQL destination plugin configuration reference

Example Configuration #

kind: destination
spec:
  name: "mysql"
  path: "cloudquery/mysql"
  registry: "cloudquery"
  version: "v5.3.3"
  # Learn more about the configuration options at https://cql.ink/mysql_destination
  spec:
    connection_string: "user:password@/dbname"
    # Optional parameters:
    # batch_size: 1000 # 1K entries
    # batch_size_bytes: 4194304 # 4 MiB

MySQL spec #

• connection_string (string) (required)

  Connection string to connect to the database. See the Go driver documentation for details.

  • "user:password@tcp(127.0.0.1:3306)/dbname" connect with TCP
  • "user:[email protected]:3306/dbname?charset=utf8mb4\u0026parseTime=True\u0026loc=Local" connect and set character set, time parsing, and location
  • "user:password@localhost:3306/dbname?timeout=30s\u0026readTimeout=1s\u0026writeTimeout=1s" connect and set various timeouts
  • "user:password@/dbname?loc=UTC\u0026allowNativePasswords=true\u0026tls=preferred" connect and set location and native password allowance, and prefer TLS
• batch_size (integer) (optional) (default: 1000)

  Maximum number of items that may be grouped together to be written in a single write.
• batch_size_bytes (integer) (optional) (default: 4194304 (= 4 MiB))

  Maximum size of items that may be grouped together to be written in a single write.

MySQL destination plugin example

Prerequisites #

• Docker installed and running

Start MySQL locally #

docker run -p 3306:3306 --name mysql -e MYSQL_ROOT_PASSWORD=test -e MYSQL_DATABASE=cloudquery -d mysql:latest

Configure MySQL destination plugin #

root:password@/cloudquery

kind: destination
spec:
  name: "mysql"
  path: "cloudquery/mysql"
  registry: "cloudquery"
  version: "v5.3.3"

  spec:
    connection_string: "root:password@/cloudquery"