Google Cloud MySQL

Google Cloud MySQL Setup Guide

Google Cloud SQL offers MySQL as a fully-managed web service. You can use Google Cloud SQL to host your MySQL database in Google Cloud Platform, and let Google Cloud handle administrative tasks such a replication, patch management, and database management for it.

You can ingest data from your Google Cloud MySQL database using Hevo Pipelines and replicate it to a Destination of your choice.

Getting Started

Setup

Data Sync

Troubleshooting

Prerequisites

The Google Cloud MySQL instance (not localhost) is running. To check this, access your Google Cloud MySQL server and look for an Active indication next to the instance name.
The MySQL version is 5.5 or higher. You can select the MySQL version while creating the instance.
Binary Log (BinLog) replication is enabled, if Pipeline mode is BinLog.
Hevo’s IP addresses are whitelisted.
SELECT and REPLICATION privileges are granted to the database user.
Username, password, database names, database hostname, and port number of the Source instance are available.
You are assigned the Team Administrator, Team Collaborator, or Pipeline Administrator role in Hevo, to create the Pipeline.

Perform the following steps to configure your Google Cloud MySQL Source:

Create a Read Replica (Optional)

If you are using an existing read-replica or connecting Hevo to your master database, skip to Set up MySQL Binary Logs for Replication section.

To create a read-replica:

Log in to the Google Cloud Console.
Access the Google Cloud SQL Instances page and click your Instance ID.
In the left navigation pane, click Replicas, and then click + CREATE READ REPLICA.
Specify the instance information relevant to your requirements, and then click CREATE REPLICA.

Set up MySQL Binary Logs for Replication

A binary log is a collection of log files that records information about data modifications and data object modifications made on a MySQL server instance. Typically binary logs are used for data replication and data recovery.

Hevo supports data ingestion for replication from servers via binary logs (BinLog). For this, binary logging must be enabled on your Google Cloud MySQL server.

To do this:

1. Check if BinLog replication is already enabled

Access your Google Cloud MySQL instance.
In the left navigation pane, under Databases, select Backups.
Under Settings, check the status of Automated backups.
If the status is Disabled, follow the steps provided below to enable BinLog replication. If the status is Enabled, ensure that the BinLog retention period is set to at least 3 days by following the steps provided below.

2. Enable BinLog replication and configure the BinLog retention period

In the left navigation pane, click Overview, and then click EDIT.
Scroll down to the Data Protection panel and select the Automated daily backups and Enable point-in-time recovery check boxes.
In the Flags panel, click ADD A DATABASE FLAG.
Click the Choose a flag field, and from the drop-down list, search and select the expire_logs_days flag.
Set the Value to at least 3 days, and then click DONE.

Note: If you are using MySQL version 8.0 or higher, search for binlog_expire_logs_seconds and set the Value greater than or equal to 259200 (three days).
Click SAVE.

This confirms that binary logging is now enabled for your Google Cloud MySQL instance.

Read BinLog to understand how database replication works in MySQL.

The replication reference guide on MySQL’s documentation portal provides a complete reference of the options available for replication and binary logging.

Whitelist Hevo’s IP Addresses

You need to whitelist the Hevo IP address for your region to enable Hevo to connect to your Google Cloud MySQL database:

Access the Google Cloud MySQL Instances page and click on the Instance ID that you want to use.
In the left navigation pane, click Connections.
On the Connections page, do the following:
1. Go to the NETWORKING tab.
2. Click the Public IP check box.
3. Click the ADD A NETWORK and specify the following:
  - Name: A name for this connection. For example, all or Hevo IP address.
  - Network: The IP address of the site to grant access to. Specify 0.0.0.0/0 to authorize all sites or 10.2.7.152 to specifically whitelist Hevo’s IP address. Check the Hevo IP address for your region.
4. Click DONE
This adds the IP address to the list of Authorized networks.
(Optional) Click Add A NETWORK to add another IP address.
Click SAVE.

Create a Database User and Grant Privileges

MySQL allows you to connect to Hevo after you configure your Google Cloud MySQL instance as an existing user or as a new user. To do this, select one of the following options:

Option 1. Configuring the user account using Google Cloud console

Click the primary Google Cloud MySQL instance.
In the left navigation pane, under PRIMARY INSTANCE, select Users, and then click + ADD USER ACCOUNT.
In the Add a user account to instance window, select one of the following methods to authenticate your user to access the instance:
- Authentication method:
  - Built-in authentication: This uses a username and password to authenticate local database users.
    - Host name: The host name determines which client hosts can connect to your instance with this user account. Default value: Allow any host (%).
  - Cloud IAM: This uses an IAM principal that provides access to the required resources in your Google Cloud MySQL instance.
Click ADD.

You will specify this username and password while creating your Hevo Pipeline.

Option 2. Configuring the user account using MySQL client

Connect to your Google Cloud MySQL database as a root user with an SQL client tool, such as MySQL workbench.
Create a database user:
```
CREATE USER '<username>'@'%' IDENTIFIED BY '<password>';
```
Note: We recommend creating a database user for connecting to your Google Cloud MySQL Source in Hevo. However, if you already have one, skip to step 3 below.
Grant SELECT and REPLICATION privileges to the user:
```
GRANT SELECT, REPLICATION CLIENT, REPLICATION SLAVE ON *.* TO '<username>'@'%';
```
Note:
- Replace the placeholder values in the commands above with your own. For example, <username> with hevo.
- The REPLICATION SLAVE privilege is required only if you connect to a read replica. When it is granted to the authenticating user, the replica logs any updates received from the main database, maintaining a record of those changes in its log.

Retrieve the Configuration Details (Optional)

1. Retrieve the hostname and port number

Note: Following is an example of Google Cloud MySQL hostname and port number: Host : 35.220.150.0 Port : 3306

Access the Google Cloud SQL Instances page.
Locate the hostname of the master and the replica instance under Public IP address column. The Google Cloud MySQL port value is 3306 by default.

You will specify these while creating your Hevo Pipeline.

2. Retrieve the username and password

To retrieve your username and password, or create a new user to connect to Hevo, read Create a User and Grant Privileges.

3. Retrieve the database names

Access the Google Cloud SQL Instances page and click on the Instance ID that you want to use.
In the left navigation pane, click Databases.

On this page, you can locate the name of the databases.

Specify Google Cloud MySQL Connection Settings

Perform the following steps to configure Google Cloud MySQL as a Source in Hevo:

Click PIPELINES in the Navigation Bar.
Click + CREATE PIPELINE in the Pipelines List View.
On the Select Source Type page, select Google Cloud MySQL.

On the Configure your Google Cloud MySQL Source page, specify the following:

GCloud MySQL settings

Pipeline Name: A unique name for your Pipeline, not exceeding 255 characters.

Database Host: The MySQL host’s IP address or DNS.

The following table lists a few examples of MySQL hosts:

Variant	Host
Amazon RDS MySQL	mysql-rds-1.xxxxx.rds.amazonaws.com
Azure MySQL	mysql.database.windows.net
Generic MySQL	10.123.10.001 or mysql-replica.westeros.inc
Google Cloud MySQL	35.220.150.0

Note: For URL-based hostnames, exclude the http:// or https:// part. For example, if the hostname URL is http://mysql-replica.westeros.inc, enter mysql-replica.westeros.inc.

Database Port: The port on which your Google Cloud MySQL server listens for connections. Default value: 3306.
Database User: The authenticated user who has the permissions to read tables in your database.
Database Password: The password for the database user.
Select an Ingestion Mode: The desired mode by which you want to ingest data from the Source. You can expand this section by clicking SEE MORE to view the list of ingestion modes to choose from. Default value: BinLog. The available ingestion modes are BinLog, Table, and Custom SQL.

Depending on the ingestion mode you select, you must configure the objects to be replicated. Refer to section, Object and Query Mode Settings for the steps to do this.

Note: For Custom SQL ingestion mode, all Events loaded to the Destination are billable.
Database Name: The database you want to load data from if the Pipeline mode is Table or Custom SQL.
Connection Settings
- Connect through SSH: Enable this option to connect to Hevo using an SSH tunnel, instead of directly connecting your MySQL database host to Hevo. This provides an additional level of security to your database by not exposing your MySQL setup to the public. Read Connecting Through SSH.
  
  If this option is disabled, you must whitelist Hevo’s IP addresses. Refer to the content for your MySQL variant for steps to do this.
- Use SSL: Enable it to use SSL encrypted connection. To enable this, specify the following:
  - CA File: The file containing the SSL server certificate authority (CA).
    - Load all CA Certificates: If selected, Hevo loads all CA certificates (up to 50) from the uploaded CA file, else it loads only the first certificate.
      
      Note: Select this check box if you have more than one certificate in your CA file.
  - Client Certificate: The client public key certificate file.
  - Client Key: The client private key file.
Advanced Settings
- Load All Databases: Applicable for Pipelines with BinLog mode. If this option is enabled, Hevo loads the data from all databases on the selected host. Else, specify a comma-separated list of Database Names you want to load data from.
- Load Historical Data: Applicable for Pipelines with BinLog mode. If this option is enabled, the entire table data is fetched during the first run of the Pipeline. If disabled, Hevo loads only the data that was written in your database after the time of creation of the Pipeline.
- Merge Tables: Applicable for Pipelines with BinLog mode. If this option is enabled, Hevo merges tables with the same name from different databases while loading the data to the warehouse. Hevo loads the Database Name field with each record. If disabled, the database name is prefixed to each table name. Read How does the Merge Tables feature work?.
- Include New Tables in the Pipeline: Applicable for all ingestion modes except Custom SQL.
  
  If enabled, Hevo automatically ingests data from tables created in the Source after the Pipeline has been built. These may include completely new tables or previously deleted tables that have been re-created in the Source.
  
  If disabled, new and re-created tables are not ingested automatically. They are added in SKIPPED state in the objects list, on the Pipeline Overview page. You can update their status to INCLUDED to ingest data. You can include these objects post-Pipeline creation to ingest data.
  
  You can change this setting later.

Click TEST CONNECTION. This button is enabled once you specify all the mandatory fields. Hevo’s underlying connectivity checker validates the connection settings you provide.
Click TEST & CONTINUE to proceed for setting up the Destination. This button is enabled once you specify all the mandatory fields.

Object and Query Mode Settings

Once you have specified the Source connection settings in Step 6 above, do one of the following:

For Pipelines with Table or BinLog mode:
1. On the Select Objects page, select the objects you want to replicate and click CONTINUE.
  
  Note: Each object represents a table in your database.
2. On the Configure Objects page, specify the query mode you want to use for each selected object.
For Pipelines with Custom SQL mode:
1. On the Provide Query Settings page, enter the custom SQL query to fetch data from the Source.
2. In the Query Mode drop-down, select the query mode, and click CONTINUE.

Data Replication

For Teams Created	Ingestion Mode	Default Ingestion Frequency	Minimum Ingestion Frequency	Maximum Ingestion Frequency	Custom Frequency Range (in Hrs)
Before Release 2.21	Table	15 Mins	15 Mins	24 Hrs	1-24
	Log-based	5 Mins	5 Mins	1 Hr	NA
After Release 2.21	Table	6 Hrs	30 Mins	24 Hrs	1-24
	Log-based	30 Mins	30 Mins	12 Hrs	1-24

Note: The custom frequency must be set in hours as an integer value. For example, 1, 2, or 3 but not 1.5 or 1.75.

Historical Data: In the first run of the Pipeline, Hevo ingests all available data for the selected objects from your Source database.
Incremental Data: Once the historical load is complete, data is ingested as per the ingestion frequency.

Additional Information

Read the detailed Hevo documentation for the following related topics:

Error 1003 - Connection to host failed

Potential Causes

The database connection details are incorrect.
Hevo’s IP addresses are not whitelisted.

Suggested Actions

Verify that the Database Host entered in the Configure your Source page is correct.
Verify that the Database Port entered in the Configure your Source page is correct.
Verify that Hevo’s IP addresses are whitelisted. Refer to the Source setup page for more information.

For Amazon RDS databases: Check that the Security Group and VPC Subnet associated with the database allows access from all Hevo’s IP addresses.
Log in as a database user with the required privileges.
Invite another team member with the required privileges to set up the Pipeline. Read Inviting and Moderating Team Members.

Error 1006 - Connection to host failed

Potential Causes

The database connection details are incorrect.
Hevo’s IP addresses are not whitelisted.

Suggested Actions

Verify that the Database Host entered in the Configure your Source page is correct.
Verify that the Database Port entered in the Configure your Source page is correct.
Verify that Hevo’s IP addresses are whitelisted. Refer to the Source setup page for more information.

For Amazon RDS databases: Check that the Security Group and VPC Subnet associated with the database allows access from all Hevo’s IP addresses.
Log in as a database user with the required privileges.
Invite another team member with the required privileges to set up the Pipeline. Read Inviting and Moderating Team Members.

Error 1007 - SSH connection failed

Potential Causes

The SSH host or user credentials are incorrect.

Suggested Actions

Verify that the SSH IP address entered in the Configure your Source page is correct.
Verify that the SSH Port entered in the Configure your Source page is correct.
Verify that the SSH user and password entered are correct.
Invite another team member with the required privileges to set up the Pipeline. Read Inviting and Moderating Team Members.

Error 1011 - Access denied

Potential Causes

The username or password is incorrect.

Suggested Actions

Verify that the Database user entered in the Configure your Source page is correct.
Verify that the Database password entered in the Configure your Source page is correct.
Invite another team member with the required privileges to set up the Pipeline. Read Inviting and Moderating Team Members.

Error 1012 - Replication access denied

Potential Causes

The access to BinLog replication is not enabled. Hevo requires Replication Slave privileges if you are connecting to a read replica database, to be able to access the BinLog.

Suggested Actions

Grant access to the user. Click the link for the respective MySQL variant for steps to do this.
Invite another team member with the required privileges to set up the Pipeline. Read Inviting and Moderating Team Members.
Log in as a database user with the required privileges.

Error 1017 - Connection to host failed

Potential Causes

The database connection details are incorrect.
Hevo’s IP addresses are not whitelisted.

Suggested Actions

Verify that the Database Host entered in the Configure your Source page is correct.
Verify that the Database Port entered in the Configure your Source page is correct.
Verify that Hevo’s IP addresses are whitelisted. Refer to the Source setup page for more information.

For Amazon RDS databases: Check that the Security Group and VPC Subnet associated with the database allows access from all Hevo’s IP addresses.
Log in as a database user with the required privileges.
Invite another team member with the required privileges to set up the Pipeline. Read Inviting and Moderating Team Members.

Error 1026 - Failed to connect to database

Potential Causes

BinLog access is not enabled. Hevo needs BinLog access for log-based replication.
The user does not have SELECT privileges.

Suggested Actions

Enable BinLog access. Click the link for the respective MySQL variant for steps to do this:
Grant privileges to the user:
1. View the grants for the user:
```
show grants for <username>@hostname;
```
  For example, show grants for jacob@localhost;.
2. Grant privileges, if not already granted. Click the link for the respective MySQL variant for steps to do this.
Invite another team member with the required privileges to set up the Pipeline. Read Inviting and Moderating Team Members.

Error 1027 - Unsupported BinLog format

Potential Causes

The binlog_format server parameter is not set to ROW. Hevo requires the ROW format for log-based replication.

Diagnosis

Launch an SQL prompt and run the following query:

SHOW VARIABLES LIKE 'binlog_format'; # This should return ROW for successful <span class='glossary-term' data-toggle='glossary-tooltip' data-class='glossary-tooltip' data-for='BinLog'>BinLog</span>-based replication

Suggested Actions

Change the binlog_format parameter to ROW. This ensures that binary replication is row-based, meaning that Events affecting individual rows are captured. Click the link for the respective MySQL variant for steps to do this.
Invite another team member with the required privileges to set up the Pipeline. Read Inviting and Moderating Team Members.

Source Considerations

MySQL does not generate log entries for cascading deletes. So, Hevo cannot capture these deletes for log-based Pipelines.

Limitations

Hevo only fetches tables from the MySQL database. It does not fetch other entities such as functions, stored procedures, views, and triggers.

To fetch views, you can create individual Pipelines in Custom SQL mode. However, some limitations may arise based on the type of data synchronization, the query mode, or the number of Events. Contact Hevo Support for more details.
During the historical load, Hevo reads table definitions directly from the MySQL database schema, whereas for incremental updates, Hevo reads from the BinLog. As a result, certain fields, such as nested JSON, are parsed differently during historical and incremental loads. In the Destination tables, nested JSON fields are parsed as a struct or JSON during historical loads, but as a string during incremental loads. This leads to a data type mismatch between the Source and Destination data, causing Events to be sidelined.

To ensure JSON fields are parsed correctly during the historical load, you can apply transformations to every table containing nested JSON fields. Contact Hevo Support for more details.
Hevo Pipelines may fail to process transactions in the BinLog if the size of the transaction exceeds 4GB. This problem is due to a MySQL bug that affects the library used by Hevo to stream Events, resulting in ingestion failures. In such cases, Hevo attempts to restart the ingestion process from the beginning of the transaction, skipping already processed Events. If the problem of transaction processing persists and the BinLog remains stuck, contact Hevo Support for assistance.

Revision History

Refer to the following table for the list of key updates made to this page:

Date	Release	Description of Change
Dec-18-2024	NA	Updated the section, Limitations to add information about Hevo handling transaction failures in the BinLog due to a MySQL bug affecting transactions exceeding 4GB.
Nov-18-2024	NA	Renamed sub-section Enable BinLog replication to Enable BinLog replication and configure the Binlog retention period and added steps for configuring the BinLog retention period.
Jul-31-2024	NA	Updated section, Limitations to add information about Hevo reading table definitions differently during historical and incremental loads.
Apr-29-2024	NA	Updated section, Specify Google Cloud MySQL Connection Settings to include more detailed steps.
Mar-18-2024	2.21.2	Updated section, Specify Google Cloud MySQL Connection Settings to add information about the Load all CA certificates option.
Mar-05-2024	2.21	Added the Data Replication section.
Nov-03-2023	NA	Renamed section, Object Settings to Object and Query Mode Settings.
Oct-27-2023	NA	Updated subsection, Configuring the user account using MySQL client with the latest steps.
Sep-04-2023	NA	Updated the page contents to reflect the latest Google Cloud MySQL user interface (UI).
Jun-26-2023	NA	Added section, Source Considerations.
Apr-21-2023	NA	Updated section, Specify Google Cloud MySQL Connection Settings to add a note to inform users that all loaded Events are billable for Custom SQL mode-based Pipelines.
Mar-09-2023	2.09	Updated section, Specify Google Cloud MySQL Connection Settings to mention about SEE MORE in the Select an Ingestion Mode section.
Dec-19-2022	2.04	Updated section, Specify Google Cloud MySQL Connection Settings to add information that you must specify all fields to create a Pipeline.
Dec-07-2022	2.03	Updated section, Specify Google Cloud MySQL Connection Settings to mention about including skipped objects post-Pipeline creation.
Dec-07-2022	2.03	Updated section, Specify Google Cloud MySQL Connection Settings to mention about the connectivity checker.
Nov-03-2022	NA	Updated section, Create a Read Replica with new screenshots to reflect the latest UI.
Oct-13-2022	1.99	Updated section, Specify Google Cloud MySQL Connection Settings to reflect the latest UI changes.
Apr-21-2022	1.86	Updated section, Specify Google Cloud MySQL Connection Settings.
Aug-09-2021	NA	Added a note in section, Option 2 Configuring the user account using MySQL client.
Jul-26-2021	1.68	Added a note for the Database Host field.
Jul-12-2021	NA	Added section, Specify Google Cloud MySQL Connection Settings.

Last updated on Dec 18, 2024

Prerequisites

Create a Read Replica (Optional)

Set up MySQL Binary Logs for Replication

1. Check if BinLog replication is already enabled

2. Enable BinLog replication and configure the BinLog retention period

Whitelist Hevo’s IP Addresses

Create a Database User and Grant Privileges

Option 1. Configuring the user account using Google Cloud console

Option 2. Configuring the user account using MySQL client

Retrieve the Configuration Details (Optional)

1. Retrieve the hostname and port number

2. Retrieve the username and password

3. Retrieve the database names

Specify Google Cloud MySQL Connection Settings

Object and Query Mode Settings

Data Replication

Additional Information

Error 1003 - Connection to host failed

Potential Causes

Suggested Actions

Error 1006 - Connection to host failed

Potential Causes

Suggested Actions

Error 1007 - SSH connection failed

Potential Causes

Suggested Actions

Error 1011 - Access denied

Potential Causes

Suggested Actions

Error 1012 - Replication access denied

Potential Causes

Suggested Actions

Error 1017 - Connection to host failed

Potential Causes

Suggested Actions

Error 1026 - Failed to connect to database

Potential Causes

Suggested Actions

Error 1027 - Unsupported BinLog format

Potential Causes

Diagnosis

Suggested Actions

Source Considerations

Limitations

See Also

Revision History

Tell us what went wrong