Prerequisites for Snowflake Connector for MySQL

Note

The Snowflake Connector for MySQL is subject to the Connector Terms.

Before installing the Snowflake Connector for MySQL, you must ensure that the following prerequisites are met in your MySQL and Snowflake environments.

Setting up the prerequisites for MySQL

Before installing the Snowflake Connector for MySQL, do the following in your MySQL environment:

  • Ensure that you have a MySQL 8 server that includes data you want to synchronize with Snowflake.

  • Set the following options for your MySQL server:

    log_bin = on
    binlog_format = row
    binlog_row_metadata = full
    binlog_row_image = full
    binlog_row_value_options =
    
    Copy

    Note

    Be cautious about the binary log expiration period (binlog_expire_logs_seconds). After it ends, binary log files might be automatically removed. If the agent is paused for a long period of time (for example due to maintenance work) and the expired binary log files are deleted during this time, the agent is not able to replicate the data from these files. Set the binary log expiration period to at least a few hours to ensure stable work of the connector.

    For more information about the automatic purging of binary log files, see MySQL Reference Manual.

Setting up the prerequisites for running the agent

Before installing the connector, you must set up the environment where the agent runs.

Configuring your firewall to access to Snowflake

If you are using a firewall, add the Snowflake hostnames and port numbers to the allowed list. See Allowing Hostnames for more information.

After adding the hostnames and port numbers to the allowed list, use SnowCD to verify the Snowflake connection from the host where you run the agent.

Downloading the MariaDB JDBC connector

On the system where you plan to run the agent, download the MariaDB JDBC Connector 3.1.2. The agent uses the MariaDB JDBC Connector to connect to MySQL.

Installing an orchestration tool

The agent is distributed as a Docker image that you can run using orchestration tools and services like Docker, Kubernetes, or OpenShift.

To run the agent, you must have one of these tools installed. Your environment must have:

  • At least 6 GB of RAM available to the container running the agent. The agent is a memory-intensive application.

  • 4 CPUs available to handle the throughput requirements of the agent. Decreasing the number of CPUs decreases the throughput linearly. Having additional CPUs does not provide significant gains.

The Snowflake Connector for MySQL requires exactly one instance of the agent application to be running at all times.

Next steps

After completing these procedures, follow the steps in Prerequisites for Snowflake Connector for MySQL datasources.