Amazon RDS MySQL - Hevo Data

Amazon RDS MySQL Setup Guide

Amazon Relational Database Service (RDS) allows you to deploy scalable MySQL servers in minutes with cost-efficient and resizable hardware capacity.

You can ingest data from your Amazon RDS MySQL database using Hevo Pipelines and replicate it to a Destination of your choice. Hevo recommends connecting to a read-replica of your master MySQL database, however, this is not mandatory. A read-replica reflects the changes to your master database in near real-time, and can reduce the load on the master database by serving all “read” requests. The Role attribute of the instance identifies its type.

Getting Started

Setup

Data Sync

Troubleshooting

Prerequisites

The Amazon RDS MySQL instance is running.
If Pipeline mode is BinLog:
- Binary Log (BinLog) replication is enabled
- The Amazon RDS MySQL database is running on MySQL version 5.6 or higher.
Hevo is authorized to connect to your database port via IP whitelisting or SSH Tunnel.
SELECT and REPLICATION privileges are granted to the database user.

Note: We recommend that you create a database user for configuring your Amazon RDS MySQL Source in Hevo. However, if you already have one, refer to section Grant privileges to the user.
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 Amazon RDS MySQL Source:

Create a Read Replica (Optional)

To use an existing read-replica or connect Hevo to your master database, skip to Set up MySQL Binary Logs for Replication section.

To create a read-replica:

Open the Amazon RDS console.
In the left navigation pane, under Dashboard, click Databases (or Instances if you are using an older version).
In the Databases section on the right, select the DB identifier of the RDS MySQL instance you want to replicate. For example, amazon-rds-mysql, in the image below.
In the Actions drop-down, click Create read replica.
On the Create read replica page, specify the following:
- Replica source: The master or primary database instance being replicated.
- DB instance identifier: The replica instance you are creating.
Select the instance specifications relevant to your requirements.
Under the Connectivity section, set the Public access option to Publicly accessible to allow connection to the DB instance via a public IP address, such as, Hevo’s IP address.
Click Create read replica. It takes a few minutes for the read replica to be created during which it show the status as Creating. The status changes to Available when the replica is created.

You can now see the read replica instance in the Databases section.

Set up MySQL Binary Logs for Replication

This step is required only for Pipelines with BinLog mode.

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.

In order for the binary log to record the data modifications, automatic backups must be enabled with a duration of at least 1 day.

Note: To use BinLog replication, your Amazon RDS MySQL database must be running on MySQL version 5.6 or higher.

To enable binary logging, follow these steps:

1. Configure the parameter group

Open the Amazon RDS console.
In the left navigation pane, click Databases (or Instances if you are using an older version).
In the Databases section on the right, select the DB instance that you want to connect.
Click the Configuration tab, and then click the link text under DB instance parameter group.
Click Edit.

Update the values of the parameters as follows:

Enter Parameter Value

Parameter Name	Value
`binlog_format`	ROW
`binlog_row_image`	full
`log_slave_updates`	1

Note: The log_slave_updates setting is required only if you are connecting to a read replica. When it is set to 1, the replica logs any updates received from the main database, maintaining a record of those changes in its log.

Click Save changes.
Reboot the database instance that you are using to connect to Hevo, to apply the above changes.

To do this:
1. In the left navigation pane, under Dashboard, select Databases.
2. In the Databases section on the right, select the DB identifier of the MySQL instance you are replicating.
3. In the Actions drop-down, click Reboot.
4. On the Reboot DB Instance page, click Confirm to reboot your DB instance.

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

2. Enable Automatic Backups

In the Amazon RDS console, in the left navigation pane, click Databases (or Instances if you are using an older version).
In the Databases section on the right, select the instance for which you want to enable automatic backups, and then click Modify.
On the Modify DB Instance page, scroll down to the Backup section.
Select the Enable automated backups check box.
Set the Backup retention period to any value greater than or equal to 1 day. A backup retention period of at least 3 days is recommended.
Click Continue.
Under the Schedule modifications panel, select Apply immediately, and then click Modify DB instance.

3. Configure the BinLog retention period

Log in to your Amazon RDS MySQL database instance with ADMIN privileges.
Run the following command to view the current BinLog retention period (in hours):
```
call mysql.rds_show_configuration;
```
If the BinLog retention period is less than 72 hours, run the following command to set it to at least 72 hours (three days).
```
call mysql.rds_set_configuration('binlog retention hours', 72);
```

Whitelist Hevo’s IP Addresses

You need to whitelist the Hevo IP address for your region to enable Hevo to connect to your Amazon RDS MySQL database.

To do this:

Open the Amazon RDS console.
In the left navigation pane, click Databases (or Instances if you are using an older version).
In the Databases section on the right, click the DB identifier of the Amazon RDS MySQL instance to configure a security group.

Note: The instance does not necessarily have to be a replica as long as it whitelists the region’s IP addresses.
In the Connectivity & security tab:
1. Note the region where your account is set up, using the Hevo App URL also. For example, the URL for the US region is https://us.hevodata.com/.
2. Click the link text under Security, VPC security groups to open the Security Groups panel.
On the Security Groups page, select the check box for your Security group ID, and from the Actions drop-down, click Edit inbound rules.
On the Edit inbound rules page:
1. Click Add rule.
2. In the Port range column, enter the port of your Amazon RDS MySQL instance. For example, 3306.
3. In the Source column, select Custom from the drop-down and enter Hevo’s IP addresses for your region.
4. Click Save rules.

Create a Database User and Grant Privileges

1. Create a database user (Optional)

Perform the following steps to create a database user in your Amazon RDS MySQL database:

Connect to your Amazon RDS 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: Replace the placeholder values in the command above with your own. For example, <username> with hevo.

2. Grant privileges to the user

The database user specified in the Hevo Pipeline must have the following global privileges:

SELECT
SUPER or (REPLICATION CLIENT and REPLICATION SLAVE)

Perform the following steps to set up these privileges:

Connect to your Amazon RDS MySQL database as a root user with an SQL client tool, such as MySQL workbench.

Grant SELECT and REPLICATION privileges to the user:

GRANT SELECT, REPLICATION CLIENT, REPLICATION SLAVE ON *.* TO <username>@'%';

Allow Hevo to access your database:

GRANT SELECT ON <database-name>.* TO <username>;

Grant privileges to the database user to read BinLog settings if ingestion mode is Binlog:
```
GRANT EXECUTE ON PROCEDURE mysql.rds_show_configuration TO '<username>'@'<hostname>';
```

Note: Replace the placeholder values in the commands above with your own. For example, <username> with hevo.

Retrieve the Hostname and Port Number (Optional)

Note: The RDS hostnames start with your database name and end with rds.amazonaws.com.
For example:
Host : mysql-rds-replica-1.xxxxxxxxx.rds.amazonaws.com
Port : 3306

In the left navigation pane of the Amazon RDS console, click Databases (or Instances if you are using an older version).
In the Databases section on the right, click the DB identifier of the Amazon RDS MySQL instance.
Click the Connectivity & security tab, and copy the values under Endpoint and Port as the hostname and port number. You will specify these while creating your Hevo Pipeline.

Specify Amazon RDS MySQL Connection Settings

Perform the following steps to configure Amazon RDS 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 Amazon RDS MySQL.

On the Configure your Amazon RDS MySQL Source page, specify the following:

RDS 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 Amazon RDS 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 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	Updated sections, Create a Read Replica (Optional) and Set up MySQL Binary Logs for Replication as per the latest Amazon RDS MySQL UI.
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 Amazon RDS MySQL Connection Settings to include more detailed steps.
Mar-18-2024	2.21.2	Updated section, Specify Amazon RDS 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 section, Create a Database User and Grant Privileges with the latest steps.
Jul-25-2023	NA	Updated section, Create a Database User and Grant Privileges for more clarity.
Jun-26-2023	NA	Added section, Source Considerations.
Apr-21-2023	NA	Updated section, Specify Amazon RDS 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 Amazon RDS MySQL Connection Settings to mention about SEE MORE in the Select an Ingestion Mode section.
Dec-19-2022	2.04	Updated section, Specify Amazon RDS MySQL Connection Settings to add information that you must specify all fields to create a Pipeline.
Dec-07-2022	2.03	Updated section, Specify Amazon RDS MySQL Connection Settings to mention about including skipped objects post-Pipeline creation.
Dec-07-2022	2.03	Updated section, Specify Amazon RDS MySQL Connection Settings to mention about the connectivity checker.
Oct-13-2022	1.99	Updated section, Specify Amazon RDS MySQL Connection Settings to reflect the latest UI changes.
Aug-24-2022	NA	Updated sections, Create a Read Replica (Optional) and Set up MySQL Binary Logs for Replication to reflect the latest UI changes.
Apr-21-2022	1.86	Updated section, Specify Amazon RDS MySQL Connection Settings.
Feb-07-2022	1.81	Updated section, Whitelist Hevo’s IP Address to remove details about Outbound rules as they are not required.
Jan-03-2022	1.79	Updated the description of the Include New Tables in the Pipeline advance setting in the Specify Amazon RDS MySQL Connection Settings section.
Aug-23-2021	1.70	Added the section, Enable Automatic Backups.
Aug-09-2021	NA	Added a note in Step 2 of section, Create a Database User and Grant Privileges section.
Jul-26-2021	1.68	Added a note for the Database Host field.
Jul-12-2021	NA	Added the section, Specify Amazon RDS MySQL Connection Settings.

Last updated on Dec 18, 2024

Prerequisites

Create a Read Replica (Optional)

Set up MySQL Binary Logs for Replication

1. Configure the parameter group

2. Enable Automatic Backups

3. Configure the BinLog retention period

Whitelist Hevo’s IP Addresses

Create a Database User and Grant Privileges

1. Create a database user (Optional)

2. Grant privileges to the user

Retrieve the Hostname and Port Number (Optional)

Specify Amazon RDS 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