MySQL Setup

The MySQL Synapse enables data synchronization between MySQL schema and Syncari entities. After the Synapse is authenticated, a user can activate the MySQL Synapse, which enables Syncari to replicate the schema of MySQL and make it available within the Unified Data Model. Using Pipeline Studio, a user can map MySQL tables to Syncari entities, and MySQL attributes to Syncari attributes.

Secure Connection Options

IP whitelist - If your MySQL security requires you to whitelist IPs you can find the list here.

SSL - SSL Connection errors can occur if the MySQL server is not configured with supported SSL/TLS protocols. (Reference this article, SSL/TLS Connection Requirements for Syncari Database Synapses)

SSH tunneling - SSL tunneling is supported by MySQL. SSH tunneling is like creating a secret, secure pathway through the internet that lets information travel safely between two computers. It hides the data from anyone trying to spy on it, so even if someone is watching the network, they can’t see what’s being sent. It’s often used to safely connect to a computer or service that’s far away, without anyone being able to peek inside the connection.

AWS

• Configuring Amazon Aurora MySQL for Syncari Connector Access via NLB
• Configuring MySQL on AWS EC2 for Syncari Connector Access via NLB

MySQL Information

You will need the following information from your MySQL administrator:

• Host Address
• Database Name
• User
• Password

If SSH tunneling is required

• Enable SSH Tunnel
• SSH Jump Server Host
• SSH Port
• SSH Username
• SSH Password
• SSH Private Key
• Private Key Passphrase

Recommended process for creating a new database for use with Syncari

If you plan on connecting the synapse to a newly created database, our recommended process is to do the following:

Synapse Setup

Step 1: Start by logging in to your Syncari subscription

1. Navigate to Synapses
2. Find MySQL in the Synapse Library
3. Drag the MySQL Synapse to the canvas

Step 2: Configure your Synapse parameters

1. Enter [Synapse Name]
   This will be the label name for the Synapse in Syncari
2. Enter [Host]
3. Enter [Database Name]

4. Click "Next"

   [OPTIONAL] Instantiate with Syncari entities - Enables Syncari to automatically create entities in MySQL

   The "Instantiate with Syncari entities" option enables all the existing entities in Syncari to be created as tables in MySQL. This feature is useful if you want the schema from the Syncari Unified Data Model to be replicated in MySQL. 

   Talk to one of our Onboarding and Support Team members if you would like any clarification or a recommendation.

Step 3: Define your SSH tunnel configuration (optional)

1. Select [Enable SSH Tunnel] - Only if SSH tunneling required

2. Enter [SSH Jump Server Host]

3. Enter [SSH Port]

4. Enter [SSH Username]

5. Enter [SSH Password] - not required if private key is used

6. Enter [SSH Private Key] - not required if password is used

7. Enter [Private Key Passphrase] - not required if password is used or ssh private key is unencrypted.

Step 4: Define your authentication parameters and authenticate:

1. Enter [User Name]
2. Enter [Password]
3. Click "Save and Authenticate"
4. Click "Next"
   [OPTIONAL] Use SSL Connection - Select this option if the connection to your server requires SSL. 

Step 5: Activate your Synapse

1. Click "Make Synapse Active"
2. Click "Close"

Congratulations! You have completed the setup of MySQL.

If you receive any errors message after clicking Authenticate, confirm each of the parameters in the previous steps are configured properly. If the error persists, contact one of our Onboarding and Support team members.

What's Next?

• Learn How to designate the Id and Watermark Attributes for MySQL Entities in Schema Studio.