Already have an account? Sign in

MySQL (HP) (v2)

MySQL integration summary

This version (v2) of Stitch’s MySQL integration optimizes replication by utilizing Avro schemas to write and validate data, thereby reducing the amount of time spent on data extraction and preparation. Compared to previous versions of the MySQL integration, this version boasts increased performance and overall reduced replication time.

Notable improvements and changes in this version also include:

• New column (field) naming rules. Avro has specific rules that dictate how columns can be named. As a result, column names will be canonicalized to adhere to Avro rules and persisted to your destination using the Avro-friendly name. Refer to theColumn name transformations section for more info.
• Improved handling ofJSON data types. In previous versions, these data types were treated as strings. This version will send them to your destination as JSON objects, which may result inde-nesting.

To get a look at how this version compares to the previous version of MySQL, refer to theMySQL version comparison documentation.

MySQL feature snapshot

A high-level look at Stitch's MySQL (v2) integration, including release status, useful links, and the features supported in Stitch.

Connecting MySQL

MySQL setup requirements

To set up MySQL in Stitch, you need:

• TheCREATE USER orINSERT privilege (for themysql database). TheCREATE USER privilege is required to create a database user for Stitch.

• TheGRANT OPTION privilege in MySQL. TheGRANT OPTION privilege is required to grant the necessary privileges to the Stitch database user.

• TheSUPER privilege in MySQL. If using binlog replication, theSUPER privilege is required to define the appropriate server settings.

Step 1: Verify your Stitch account's data pipeline region

First, you’ll log into Stitch and verify the data pipeline region your account is using. Later in this guide, you’ll need to grant Stitch access by whitelisting our IP addresses.

The IP addresses you’ll whitelist depend on theData pipeline region your account is in.

1. Sign into your Stitch account, if you haven’t already.
2. ClickUser menu (your icon) > Edit User Settings and locate theData pipeline region section to verify your account’s region.

3. Locate the list of IP addresses for your region:

   • North America region IP addresses

   • Europe region IP addresses

Keep this list handy - you’ll need it later.

Step 2: Configure database connection settings

In this step, you’ll configure the database server to allow traffic from Stitch to access it. There are two ways to connect your database:

• A direct connection will work if your database is publicly accessible.
• An SSH tunnel is required if your database isn’t publicly accessible. This method uses a publicly accessible instance, or an SSH server, to act as an intermediary between Stitch and your database. The SSH server will forward traffic from Stitch through an encrypted tunnel to the private database.

Click the option you’re using below and follow the instructions.

Step 3: Configure Log-based Incremental Replication

While Log-based Incremental Replication is the most accurate and efficient method of replication, using this replication method may, at times, require manual intervention or impact the source database’s performance. Refer to theLog-based Incremental Replication documentation for more info.

You can also use one of Stitch’s otherReplication Methods, which don’t require any database configuration. Replication Methods can be changed at any time.

• Step 3.1: Configure server settings

• Step 3.2: Retrieve server IDs

Step 3.1: Configure server settings

In this step, you’ll configure your MySQL server to use Log-based Incremental Replication.

• Instructions
• Server settings list

Step 3.2: Retrieve server IDs

When Stitch connects to your database and uses Log-based Replication, a unique server ID will be required. This ID ensures that the integration - or integrations, if you’re connecting multiple databases - will not encounter conflicts during the replication process.

To avoid conflicts, you’ll check which server IDs are currently in use and then define a new, unqiue ID in Stitch.

1. Log into the MySQL server that acts as the replication master.

2. Run the following statement:

   mysql>SHOWSLAVEHOSTS;

3. TheSHOW SLAVE HOSTS statement will return information about servers that are or have been connected as replication slaves:

   +------------+-------------+------+-----------+------------+|Server_id|Host|Port|Master_id|Slave_UUID|+------------+-------------+------+-----------+------------+|192168010|stitch_prod|3306|192168011|<UUID>||1921680101|stitch_dev|3306|192168011|<UUID>|+------------+-------------+------+-----------+------------+

When you complete the setup in Stitch, you’ll define a unique server ID for your Stitch MySQL integration to use.

Step 4: Create a Stitch database user

Next, you’ll create a dedicated database user for Stitch. This will ensure Stitch is visible in any logs or audits, and allow you to maintain your privilege hierarchy.

• Instructions
• Privileges list

GRANTREPLICATIONCLIENT,REPLICATIONSLAVEON*.*TO'<stitch_username>'@'localhost';

Step 5: Connect Stitch

In this step, you’ll complete the setup by entering the database’s connection details and defining replication settings in Stitch.

• Step 5.1: Define the database connection details

• Step 5.2: Define the SSH connection details

• Step 5.3: Define the SSL connection details

• Step 5.4: Select databases to discover

• Step 5.5: Define the Log-based Replication setting

• Step 5.6: Create a replication schedule

• Step 5.7: Save the integration

Step 5.1: Define the database connection details

1. If you aren’t signed into your Stitch account,sign in now.

2. On the Stitch Dashboard page, click theAdd Integration button.

3. Locate and click theMySQL icon.

4. Fill in the fields as follows:

   • Integration Name: Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

     For example, the name “Stitch MySQL” would create a schema calledstitch_mysql in the destination.Note: The schema name cannot be changed after the integration is saved.

   • Host (Endpoint): Enter the host address (endpoint) used by the MySQL instance. For example: This could be a network address such as192.68.0.1, or a server endpoint likedbname.hosting-provider.com.

   • Port: Enter the port used by the MySQL instance. The default is3306.

   • Username: Enter the Stitch MySQL database user’s username.

   • Password: Enter the password for the Stitch MySQL database user.

   • Server ID:Optional: Enter the unique server ID of instance you’re connecting to Stitch.

     This can be any numeric value withinMySQL’s accepted server ID range, as long as it’s unique to the instance. For example: If in theRetrieve Server IDs step there are servers with the IDs192168010 and1921680101, you can enter any other numbers in this field.

Step 5.2: Define the SSH connection details

If you’re using an SSH tunnel to connect your MySQL database to Stitch, you’ll also need to define the SSH settings. Refer to theSetting up an SSH Tunnel for a database connection guide for assistance with completing these fields.

1. Click theSSH Tunnel checkbox.

2. Fill in the fields as follows:

   • SSH Host: Enter the public IP address or hostname of the server Stitch will SSH into.

   • SSH Port: Enter the SSH port on your server. (22 by default)

   • SSH User: Enter the Stitch Linux (SSH) user’s username.

Step 5.3: Define the SSL connection details

1. Check theConnect using SSL checkbox.Note: The database must support and allow SSL connections for this setting to work correctly.

2. Fill in the fields as follows:

   • SSL Certificate: The certificate (typically a CA or server certificate) Stitch should verify the SSL connection against. The connection will succeed only if the server’s certifcate verifies against the certificate provided.

     Note: Providing a certifcate via this property isn’t required to use SSL. This is only if Stitch should verify the connection against a specific certificate.

   • Use an SSL client key: If SSL client authentication should be used, check this box. This will display theClient Certificate andClient Key fields, which are both required when using client authentication.

   • Client Certificate: If using SSL client authentication, paste the client certificate Stitch should use into this field.Note: You must also provide aClient Key for the connection to be successful.

   • Client Key: If using SSL client authentication, paste the client key Stitch should use into this field.Note: You must also provide aClient Certificate for the connection to be successful.

Step 5.4: Select databases to discover

Enter a database name in the field underFilter databases in the source to select the database that Stitch can discover. You can add multiple database names by clickingAdd another database.

If no database is specified, Stitch will discover all databases on the host.

Step 5.5: Define the Log-based Replication setting

In theLog-based Replication section, you can set this as the integration’s default Replication Method.

When enabled, tables that are set to replicate will useLog-based Incremental Replication by default. If you don’t want a table to use Log-based Incremental Replication, you can change it in the Table Settings page for that table.

If this setting isn’t enabled, you’ll have to select aReplication Method for each table you set to replicate.

Step 5.6: Create a replication schedule

In theReplication Frequency section, you’ll create the integration’sreplication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

MySQL integrations support the following replication scheduling methods:

• Replication Frequency

• Anchor Scheduling

• Advanced Scheduling using Cron (Advanced or Premium plans only)

To keep your row usage low, consider setting the integration to replicate less frequently. See theUnderstanding and Reducing Your Row Usage guide for tips on reducing your usage.

Step 5.7: Save the integration

When finished, clickCheck and Save.

Stitch will perform a connection test to the MySQL database; if successful, aSuccess! message will display at the top of the screen.Note: This test may take a few minutes to complete.

Step 6: Select data to replicate

The last step is to select the tables and columns you want to replicate.

Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.

• Selection options
• Individual tables and columns
• All tables and columns
• Database views

Initial and historical replication jobs

After you finish setting up MySQL, itsSync Status may show asPending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, aPending status indicates that Stitch is in the process of scheduling the initial replication job for the integration.This may take some time to complete.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.

MySQL replication

In this section:

• Details about Extraction, including object and data type discovery and selecting data for replication

Extraction

For every table set to replicate, Stitch will perform the following during Extraction:

• Discover table schemas and type discovered columns

• Select records for replication

Discovery

During Discovery, Stitch will:

• Determine table schemas

• Type the data in discovered columns

Determining table schemas

During this phase of Discovery, Stitch queries system tables to retrieve metadata about the objects the Stitch database user has access to. This metadata is used to determine which databases, tables, and columns to display in Stitch for replication.

Stitch runs the following queries on MySQL databases to perform a structure sync:

• SHOW DATABASES
• SHOW TABLES FROM [database_name]
• SHOW KEYS FROM [table_name]
• SELECT * FROM INFORMATION_SCHEMA.TABLES

Data typing

Refer to theMySQL data types documentation for more info about how MySQL data is typed for selected columns.

Data replication

During data replication, Stitch will:

• Transform column names to adhere to Avro rules

Column name transformations

To ensure column names are compatible with Avro, the integration will transform column names to adhere to Avro’s rules. In Avro,column names must:

• Start with one of the following:
  • A-Z
  • a-z
  • _ (underscore)
• Contain only the following:
  • Any characters in the list above (A-Z,_, etc)
  • 0-9

If a column name contains an unsupported character, the integration will replace it with an underscore (_).

Did this article help? If you have questions or feedback, feel free tosubmit a pull request with your suggestions,open an issue on GitHub, orreach out to us.