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.
A high-level look at Stitch's Magento integration, including release status, useful links, and the features supported in Stitch.
|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: 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: Retrieve your Stitch public key
The Public Key is used to authorize the Stitch Linux user. If the key isn’t properly installed, Stitch will be unable to access your database.
To retrieve the key:
On the Stitch Dashboard page, click the Add Integration button.
Click the MySQL icon.
Click the SSH Tunnel checkbox.
The Public Key will display, along with the other SSH fields.
Leave this page open for now - you’ll need it to wrap things up at the end.
Step 3: Create a Stitch Linux user
Run the following commands as root on your Linux server to create a user named
adduser --disabled-password stitch mkdir /home/stitch/.ssh
Next, import the Public Key into
[PASTE KEY HERE]with the Stitch Public Key:
echo "[PASTE KEY HERE]" >> /home/[stitch_username]/.ssh/authorized_keys
Alter the permissions on the
/home/stitchdirectory to allow access via SSH:
chown -R [stitch_username]:stitch /home/stitch chmod -R 700 /home/stitch/.ssh
Step 4: Create a Stitch database user
- 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 on the database:
GRANT SELECT ON *.* TO '[stitch_username]';
To restrict the Stitch user from accessing data in specific objects, you can instead run
GRANTcommands that only allow access to the data you permit.
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
- Sign into your Stitch account, if you haven’t already.
- On the Stitch Dashboard page, click the Add Integration button.
- Click the 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 Magento” would create a schema called
stitch_magentoin 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 Magento instance.
In general, this will be
127.0.0.1(localhost), but could also be some other network address (ex:
184.108.40.206) 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 Magento instance. The default is
Username: Enter the Stitch Magento 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 5.2: 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.
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 6: 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.
After you set a table to replicate, the Settings page will display. Note: When you track a table, by default all columns will also be tracked.
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.