This integration is powered by Singer's MySQL tap and certified by Stitch. Check out and contribute to the repo on GitHub.
For support, contact Stitch support.
Magento feature snapshot
A high-level look at Stitch's Magento (v1) integration, including release status, useful links, and the features supported in Stitch.
Released on October 24, 2017
|Singer GitHub repository|
|Configurable Replication Methods||
|Full Table Replication||
Magento setup requirements
To set up Magento in Stitch, you need:
Permissions in Magento that allow you to create/manage users. This is required to create the Stitch database user.
Step 1: 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.
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:
- Follow the steps in the Setting up an SSH Tunnel for a database connection guide to set up an SSH tunnel for Magento.
- Complete the steps in this guide after the SSH setup is complete.
Step 2: Create a Stitch database user
GRANT OPTIONprivileges to complete this step.
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.
- Log into your database as a user with
Run the following command to create the Stitch database user:
CREATE USER '<stitch_username>'@'localhost' IDENTIFIED BY '<password>';
<password>with a secure password. If using SSH, this can be different than the SSH password.
Grant the Stitch user
SELECTprivileges by running this command for every table you want to replicate:
GRANT SELECT ON '<database_name>'.'<table_name>' to '<stitch_username>'@'localhost';
Limiting access to only the tables you want to replicate ensures that the integration can complete discovery (a structure sync) in a timely manner. If you encounter issues in Stitch where tables aren’t displaying, try limiting the Stitch database user’s table access.
See the Privileges list tab for an explanation of why these permissions are required by Stitch.
In the table below are the database user privileges Stitch requires to connect to and replicate data from a Magento database.
|Privilege name||Reason for requirement|
Required to select rows from tables in a database.
Step 3: Connect Stitch
In this step, you’ll complete the setup by entering the database’s connection details and defining replication settings in Stitch.
Step 3.1: Define the database connection details
- If you aren’t signed into your Stitch account, sign in now.
On the Stitch Dashboard page, click the Add Integration button.
- Locate and click the MySQL icon.
- Fill in the fields as follows:
Step 3.2: Define the SSH connection details
If you’re using an SSH tunnel to connect your Magento database to Stitch, you’ll also need to define the SSH settings. Refer to the Setting up an SSH Tunnel for a database connection guide for assistance with completing these fields.
Click the SSH Tunnel checkbox.
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. (
SSH User: Enter the Stitch Linux (SSH) user’s username.
Step 3.3: 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.
Magento integrations support the following replication scheduling methods:
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 4: Select data to replicate
The last step is to select select the tables and columns you want to replicate.
Replicating MyISAM tables
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 select 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. Note: When you track a table, by default all columns will also be tracked.
After you set a table to replicate, a page with the table’s columns will display. De-select columns if needed.
In the 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 Magento, 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.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
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.