MySQL destination plugin example

Latest: v2.0.2

In this article we will show you a simple example of configuring MySQL destination plugin.

Prerequisites

Docker (opens in a new tab) 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

For brevity we only set the MYSQL_ROOT_PASSWORD and MYSQL_DATABASE environment variables. You should create dedicated and secure credentials for production use. For the docker image documentation see here (opens in a new tab). Also, if you're running on Apple silicon based Macs you might need to add the --platform linux/amd64 flag to the above command.

Configure MySQL destination plugin

Once you've completed the steps from previous sections you should be able to connect to the local cloudquery MySQL database via the following connection string:

root:password@/cloudquery

The (top level) spec section is described in the Destination Spec Reference. The full configuration for the MySQL destination plugin should look like this:

kind: destination
spec:
  name:     "mysql"
  registry: "github"
  path:     "cloudquery/mysql"
  version:  "v2.0.2"

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

Make sure you use environment variable expansion in production instead of committing the credentials to the configuration file directly.

Configuration Overview