Google CloudSQL MySQL (v2)

Google CloudSQL MySQL integration summary

This version (v2) of Stitch’s Google CloudSQL 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 Google CloudSQL 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 the Column name transformations section for more info.
• Improved handling of JSON 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 in de-nesting.

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

Google CloudSQL MySQL feature snapshot

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

Connecting Google CloudSQL MySQL

Google CloudSQL MySQL setup requirements

To set up Google CloudSQL MySQL in Stitch, you need:

• Permissions in Google Cloud that allow you to modify the database’s connection settings. This is required to whitelist Stitch’s IP addresses.

• The CREATE USER or INSERT privilege (for the mysql database). The CREATE USER privilege is required to create a database user for Stitch.

• The GRANT OPTION privilege. The GRANT OPTION privilege is required to grant the necessary privileges to the Stitch database user.

• If using Log-based Replication, you’ll need:

  • A database running MySQL 5.6.2 or greater Earlier versions of MySQL do not include binlog replication functionality, which is required for Log-based Replication.
  • To connect to the master instance. Google doesn’t currently support binlog replication on read replicas.

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 the Data pipeline region your account is in.

1. Sign into your Stitch account, if you haven’t already.
2. Click User menu (your icon) > Edit User Settings and locate the Data 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

For Stitch to successfully connect with your CloudSQL instance, you’ll need to add our IP addresses to the database’s authorized networks list.

1. Sign into your Google Cloud Platform account.
2. Navigate to the Cloud SQL Instances page.
3. Click the instance name to open its details page.
4. Click the Connections tab.
5. Locate the Public IP section.

6. For each of the Stitch data pipeline region IP addresses you retrieved in Step 1, complete the following:

   1. Click + Add network.
   2. In the Name field, enter a name for the IP address. For example: Stitch 1 for the first IP address, Stitch 2 for the second, and so on.
   3. In the Network field, paste one of the IP addresses for your Stitch data pipeline region that you retrieved in Step 1.
   4. Click Done.
   5. Repeat these steps until all of Stitch’s IP addresses for your data pipeline region have been added.
7. When finished, click Save to update the instance.

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 the Log-based Incremental Replication documentation for more info.

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

• Step 3.1: Enable automated backups and binary logging

• Step 3.2: Retrieve server IDs

Step 3.1: Enable automated backups and binary logging

In this step, you’ll enable automated backups and binary logging for the Google CloudSQL MySQL database. This is required 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> SHOW SLAVE HOSTS;
   

3. The SHOW 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 Google CloudSQL 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

GRANT REPLICATION CLIENT, REPLICATION SLAVE ON *.* 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: Locate the database connection details in Google

• Step 5.2: Define the database connection details in Stitch

• Step 5.3: Select databases to discover

• Step 5.4: Define the Log-based Replication setting

• Step 5.5: Create a replication schedule

• Step 5.6: Save the integration

Step 5.1: Locate the database connection details in Google

In this step, you’ll locate the Google CloudSQL MySQL database’s IP address in the Google Cloud Platform console. This will be used to complete the setup in Stitch.

In this step, you’ll locate the Google CloudSQL MySQL database’s public IP address in the Google Cloud Platform console. This will be used to complete the setup in Stitch.

1. In the CloudSQL Instances page, locate the instance you want to connect to Stitch.
2. When the instance’s Overview page displays, scroll down to the Connect to this instance section.
3. Locate the Public IP address field.
4. Copy and paste the public IP address into a text file or leave this page open and open your Stitch account in another tab.

Step 5.2: Define the database connection details in Stitch

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

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

3. Locate and click the Google CloudSQL MySQL 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 Google CloudSQL MySQL” would create a schema called stitch_google_cloudsql_mysql in the destination. Note: The schema name cannot be changed after the integration is saved.

   • Integration Name: Enter the host address (endpoint) of your Google CloudSQL MySQL instance. This will be the value of the Public IP address that you retrieved in the previous step.

   • Port: Enter the port used by the Google CloudSQL MySQL instance. The default is 3306.

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

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

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

     This can be any numeric value within MySQL’s accepted server ID range, as long as it’s unique to the instance. For example: If in the Retrieve Server IDs step there are servers with the IDs 192168010 and 1921680101, you can enter any other numbers in this field.

Step 5.3: Select databases to discover

Enter a database name in the field under Filter databases in the source to select the database that Stitch can discover. You can add multiple database names by clicking Add another database.

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

Step 5.4: Define the Log-based Replication setting

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

When enabled, tables that are set to replicate will use Log-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 a Replication Method for each table you set to replicate.

Step 5.5: Create a replication schedule

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

Google CloudSQL 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 the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.

Step 5.6: Save the integration

When finished, click Check and Save.

Stitch will perform a connection test to the Google CloudSQL MySQL database; if successful, a Success! 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 Google CloudSQL MySQL, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending 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.

Google CloudSQL 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 Google CloudSQL 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 the Google CloudSQL MySQL data types documentation for more info about how Google CloudSQL 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 to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.