MySQL Data Sync

This comprehensive document will walk you through the step-by-step configuration process for MySQL data sync and address specific use cases tailored to MySQL .

Pre-requisites

Your MySQL tables must have a primary key column. If you don't have it, please refer to the section Configuring a Primary Key for Your MySQL Table for adding it.

Standard Data Sync functionality

Please refer to Data Sync - Getting Started for the standard data sync functionality. The getting started document covers the usage of data sync features valid for all integrations.

Configuring MySQL Data Sync

Step 1: Start the Sync Setup

1. Log in to your Byteline account and navigate to the My Syncs page.
2. Click on the "Create Sync" button to begin the configuration.

Step 2: Select MySQL as Your First App

1. Choose MySQL as the first app to sync.
   Alternatively, you can select another app first and then pick MySQL as the second app.

   

2. Click on the "Sign In" button under MySQL to connect it to Byteline.
3. Now select the MySQL schema that you want to use.

Step 3: Connect the Second App

1. Select the second app for syncing and log in to authorize the connection.
2. Once connected, click "Continue" to move to the table mapping screen.

Step 4: Map Tables Between MySQL and the Other App

1. Select the tables you want to sync between the two apps.

   

Select Which Data to Sync

Step 6: Configure Field Mapping

1. On the Field Mapping screen, drag and drop fields from the right panel into the mapped fields column to create mappings.

   

2. To delete a mapping, click the X button next to the field.
3. Select the sync direction at the field level using the arrow buttons.
   One-Way Sync: Data flows from one app to the other.
   Two-Way Sync: Data flows bidirectionally between both apps.
4. Once your mappings are finalized, click "Continue."

Step 7: Sync Existing Data Configuration

Select the sync direction for your existing data:

Step 8: Review Sync Preview

1. Preview the sync setup to ensure everything is configured correctly.
2. If all looks good, click "Start Sync."
3. Byteline will sync your existing data and make the sync live.

   

Configuring a Primary Key for Your MySQL Table

A primary key is required on a table for it to work with data sync. If your MySQL table doesn’t already have a primary key, you can add one using either of the methods below.

Option 1: Add an Auto-Increment Primary Key (Recommended)

Use this method when your table doesn’t already have a suitable column for a primary key. This adds a new column that automatically generates unique IDs and sets it as the primary key.

ALTER TABLE blogs ADD COLUMN id INT AUTO_INCREMENT PRIMARY KEY;

This adds a new id column that:

• Auto-increments with each new row
• Acts as the primary key

Option 2: Use an Existing Column as Primary Key

Use this method if you already have a column (like title, email, or user_id) that contains unique and non-null values.

⚠️ Important: The column you choose must not contain duplicate or NULL values.

ALTER TABLE blogs ADD PRIMARY KEY (title);

Syncing Data from localhost Using Ngrok

Usually, your database wouldn't be on the local machine. But if it is, and you want to sync data to or from it using Byteline, Ngrok can help expose your local database to the internet securely.

Steps to Access a Local Database Using Ngrok

1. Install Ngrok

Download and install Ngrok from https://ngrok.com/download. Follow the installation instructions provided for your operating system.

2. Expose Your Local Database Using Ngrok

Ngrok can expose a TCP connection for your local database. Use the following command to expose your database:

ngrok tcp <port>

Replace <port> with the port your database is running on (e.g., 3306).

Example for a MySQL database running on port 3306:

ngrok tcp 3306

Ngrok will generate a public TCP address (e.g., 0.tcp.ngrok.io:12345) that tunnels to your local database.

3. Update Database Configuration in Byteline

In the Byteline data sync configuration, use the Ngrok TCP address as the database host. For example:

Host: 0.tcp.ngrok.io

Port: 12345

Username: Your database username

Password: Your database password

Database Name: The name of your database

4. Test the Connection

Use the "Test Connection" feature in Byteline to ensure the platform can connect to your local database through the Ngrok TCP tunnel.

5. Run the Sync

After successfully testing the connection, initiate the data sync as you normally would. Byteline will access your local database through the Ngrok tunnel.