Azure MySQL (Edge)

Prerequisites

• The Azure MySQL database instance (not the local host) is running. To check this:

  1. Log in to the Microsoft Azure Portal and select the Azure MySQL database you want to connect to Hevo.

  2. In the Overview tab, confirm that the Status field has the value Available.

     

• The MySQL version is 8.0 or higher. You can choose the MySQL version while creating the instance.

• Binary Log (BinLog) replication is enabled.

• Hevo’s IP address(es) for your region is added to the Azure MySQL database IP Allowlist.

• The SELECT, RELOAD, SHOW DATABASES, and REPLICATION privileges are granted to the database user.

  Note: We recommend that you create a database user for configuring your Azure MySQL Source in Hevo. However, if you already have one, refer to section Grant privileges to the user.

• The database hostname and port number of the Source instance are available.

---

Perform the following steps to configure your Azure MySQL Source:

Create a Read Replica (Optional)

---

Set up MySQL Binary Logs for Replication

Hevo supports data ingestion from the MySQL database instance via binary logs (BinLog). A binary log is a collection of log files that records information about data modifications and data object modifications made on a MySQL database instance. Typically, binary logs are used for data replication and data recovery.

By default, Row-based BinLog Replication in Azure MySQL. To change this to capture the entire data:

1. Access your Microsoft Azure MySQL instance.

2. Under Resources, Recent tab, select the database you want to synchronize with Hevo.

   

3. In the left navigation pane, under Settings, click Server Parameters.

4. Under the Top tab, update the values of the parameters as follows:

   Parameter Name	Value
   binlog_format	ROW
   binlog_row_image	full
   binlog_expire_logs_seconds	A value greater than or equal to 259200 (three days).
   gtid_mode	ON
   enforce_gtid_consistency	ON

   Note:

   • Enabling GTID is recommended because it makes replication simpler and helps ensure that the primary and replica servers are in sync with each other.

   • Ensure that the value of binlog_row_value_options parameter is not set to PARTIAL_JSON.

   

5. Click Save.

6. Confirm under Notifications that your changes have been applied and the instance has restarted successfully before running the Pipeline, to avoid errors.

   

---

Allowlist Hevo IP addresses for your region

You need to allowlist the Hevo IP addresses for your region to enable Hevo to connect to your Microsoft Azure MySQL database. You can do this by creating firewall rules in your Microsoft Azure database settings as follows:

1. Access your Microsoft Azure MySQL instance.

2. Under Resources, Recent tab, select the database you want to synchronize with Hevo.

   

3. In the left navigation pane, under Settings, click Networking.

4. Create a Firewall Rule:

   1. Specify a Firewall Rule Name.

   2. Specify Hevo’s IP addresses in the Start IP address and End IP address fields as per your region, and then click Save to save the rule.

      Note: As Hevo has specific IP addresses and not a range, the value in Start IP address and End IP address fields is the same.

      

   3. Repeat this step to add the IP address for each applicable Hevo region.

---

Create a Database User and Grant Privileges

1. Create a database user (Optional)

2. Grant privileges to the user

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

• SELECT - Select data from tables in your database which you want to replicate.

• RELOAD - Access to clear or reload internal caches, flush tables, or acquire locks.

• SHOW DATABASES - View list of database names in the server.

• REPLICATION CLIENT - Access to the MySQL server BinLog for replication.

• REPLICATION SLAVE - Access replication status and log details.

Note: The SELECT, RELOAD, and SHOW DATABASES privileges are only required during the historical load.

Perform the following steps to set up these privileges:

1. Connect to your Azure MySQL database as an admin user with an SQL client tool, such as MySQL workbench.

2. Grant the required privileges to the user:

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

3. (Optional) View the grants for the user:

   show grants for <username>@localhost;
   

4. Finalize the user’s permissions:

   FLUSH PRIVILEGES;
   

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 Database Hostname and Port Number (Optional)

---