This integration is powered by Singer's CloudSQL MySQL tap and certified by Stitch. Check out and contribute to the repo on GitHub.
For support, contact Stitch support.
This article only applies to MySQL-based CloudSQL databases.
If you want to connect a PostgreSQL-based CloudSQL instance, use these instructions.
|Release Status||Released||Supported By||Stitch|
|SSL Connections||Unsupported||VPN Connections||Unsupported|
|Whitelisting||Tables and columns||View Replication||Unsupported|
Connecting CloudSQL MySQL
CloudSQL MySQL Setup Requirements
To set up CloudSQL MySQL in Stitch, you need:
Permissions in CloudSQL MySQL that allow you to create/manage users. This is required to create the Stitch database user.
Step 1: Whitelist Stitch's IP addresses
For the connection to be successful, you’ll need to configure your firewall to allow access from our IP addresses. Whitelist the following IPs before continuing onto the next step:
Step 2: Create a Stitch database user
To create a database user for Stitch, run the following command when logged into CloudSQL MySQL:
CREATE USER '[stitch_username]'@'localhost' IDENTIFIED BY '[password]'; GRANT SELECT, REPLICATION CLIENT, REPLICATION SLAVE ON *.* TO '[stitch_username]';
[password] with a secure password.
If you wish to restrict this user from accessing data in specific databases, tables, or columns, you can instead run
GRANT queries that only allow access to the data you permit.
Step 3: Connect Stitch
- Sign into your Stitch account, if you haven’t already.
On the Stitch Dashboard page, click the Add Integration button.
Click the CloudSQL MySQL icon.
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 data warehouse.
For example, the name “Stitch CloudSQL MySQL” would create a schema called
stitch_cloudsql_mysqlin the data warehouse. Note: The schema name cannot be changed after the integration is saved.
Host (Endpoint): Enter the host address (endpoint) used by the CloudSQL MySQL instance.
In general, this will be
127.0.0.1(localhost), but could also be some other network address (ex:
220.127.116.11) or your server’s public IP address. Note: This must be the actual address - entering
localhostinto this field will cause connection issues.
Port: Enter the port used by the CloudSQL MySQL instance. The default is
Username: Enter the Stitch CloudSQL MySQL database user’s username.
Password: Enter the password for the Stitch database user.
Database: Optional: Enter the name of the default database Stitch will connect to. Stitch will ‘find’ all databases you give the Stitch user access to - a default database is only used to test and complete the connection.
Step 4: 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.
Stitch offers two methods of creating a replication schedule:
- Replication Frequency: This method requires selecting the interval you want replication to run for the integration. Start times of replication jobs are based on the start time and duration of the previous job. Refer to the Replication Frequency documentation for more information and examples.
Anchor scheduling: Based on the Replication Frequency, or interval, you select, this method “anchors” the start times of this integration’s replication jobs to a time you select to create a predictable schedule. Anchor scheduling is a combination of the Anchor Time and Replication Frequency settings, which must both be defined to use this method. Additionally, note that:
- A Replication Frequency of at least one hour is required to use anchor scheduling.
An initial replication job may not begin immediately after saving the integration, depending on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
- You’ll need to contact support to request using an Anchor Time with this integration.
To help prevent overages, 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: Select data to replicate
The last step is to select the tables and columns you want to replicate. When you track a table, you’ll also need to define its Replication Method and, if using Key-based Incremental Replication, its Replication Key.
Because MyISAM tables implement table-level locking when queries are executed, any time Stitch queries a MyISAM table during a replication job, the entire table will be locked.
For this reason, we recommend connecting only read replicas to Stitch to prevent locking tables in your production database. Additionally, consider converting tables to the InnoDB format (which only uses row-level locking) where possible.
You can track tables and columns by:
- In the Integration Details page, click the Tables to Replicate tab.
- Locate a table you want to replicate.
- Click the checkbox next to the object’s name. A green checkmark means the object is set to replicate.
- If there are child objects, they’ll automatically display and you’ll be prompted to select some.
- After you set a table to replicate, the Table Settings page will display. Note: When you track a table, by default all columns will also be tracked.
In the Table Settings page, define the table’s Replication Method and, if using Key-based Incremental Replication, its Replication Key.
Repeat this process for every table you want to replicate.
- Click the Finalize Your Selections button to save your data selections.
Initial and historical replication jobs
After you finish setting up 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.
Extracting data from CloudSQL MySQL
When you connect a database as an input, Stitch only needs read-only access to the databases, tables, and columns you want to replicate. There are two processes Stitch runs during the Extraction phase of the replication process: a structure sync and a data sync.
Structure sync queries
The first part of the replication process is called a structure sync. This process will detect any changes to the structure of your database. For example: a new column is added to one of the tables you’re syncing in Stitch.
Stitch runs the following queries on CloudSQL MySQL databases to perform a structure sync:
SHOW KEYS FROM [table]
SELECT * FROM INFORMATION_SCHEMA.TABLES
Data sync queries
The second step in the Extraction phase is called a data sync. This is where Stitch extracts data and replicates it. The method Stitch uses is the same for all databases, but differs depending on the Replication Method that each table uses.
Key-based Incremental Replication
For tables using Key-based Incremental Replication, Stitch runs a single query and reads out of the associated cursor in batches:
SELECT column_a, column_b <,...> FROM table_a WHERE replication_key_column >= 'last_maximum_replication_key_value' ORDER BY replication_key_column
Full Table Replication
For tables using Full Table Replication, Stitch runs a single query and reads out of the resulting cursor in batches:
SELECT column_a, column_b <,...> FROM table_a
While we make every effort to ensure the queries that Stitch executes don’t impart significant load on your databases, we still have some recommendations for guaranteeing database performance:
- Use a replica database instead of connecting directly. We recommend using read replicas in lieu of directly connecting production databases with high availability and performance requirements.
- Apply indexes to Replication Key columns. We restrict and order our replication queries by this column, so applying an index to the columns you’re using as Replication Keys can improve performance.