Back to plugin list
Official
MySQL
This plugin is in preview.
This destination plugin lets you sync data from a CloudQuery source to a MySQL database
Publisher
cloudquery
Repositorygithub.com
Latest version
v4.2.4
Type
Destination
Platforms
Date Published
Mar 12, 2024
Price
Free
Overview
MySQL destination plugin
This destination plugin lets you sync data from a CloudQuery source to a MySQL database.
Supported database versions are >= 5.7.
MariaDB is not fully supported. If MariaDB compatibility is needed please upvote the open GitHub issue
Configuration
MySQL destination plugin configuration reference
Example Configuration
kind: destination
spec:
name: "mysql"
path: "cloudquery/mysql"
registry: "cloudquery"
version: "v4.2.4"
spec:
connection_string: "user:password@/dbname"
# Optional parameters:
# batch_size: 1000 # 1K entries
# batch_size_bytes: 4194304 # 4 MiB
The MySQL destination utilizes batching, and supports
batch_size
and batch_size_bytes
.MySQL spec
This is the (nested) spec used by the MySQL destination plugin.
connection_string
(string
) (required)Connection string to connect to the database. See the Go driver documentation for details.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.
Example
MySQL destination plugin example
In this article we will show you a simple example of configuring MySQL destination plugin.
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
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"
path: "cloudquery/mysql"
registry: "cloudquery"
version: "v4.2.4"
spec:
connection_string: "root:password@/cloudquery"