This integration is powered by Singer's Magento 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.
STITCH | |||
Release status |
Deprecated on November 8, 2021 |
Supported by | |
Stitch plan |
Standard |
Supported versions |
n/a |
API availability |
Not available |
Singer GitHub repository | |
CONNECTION METHODS | |||
SSH connections |
Supported |
SSL connections |
Unsupported |
REPLICATION SETTINGS | |||
Anchor Scheduling |
Supported |
Advanced Scheduling |
Supported |
Table-level reset |
Supported |
Configurable Replication Methods |
Supported |
REPLICATION METHODS | |||
Log-based Replication |
Unsupported |
Key-based Replication |
Supported |
Full Table Replication |
Supported |
||
DATA SELECTION | |||
Table selection |
Supported |
Column selection |
Supported |
View replication |
Unsupported |
Select all |
Supported, with prerequisites |
TRANSPARENCY | |||
Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting Magento
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.
The IP addresses you’ll whitelist depend on the Data pipeline region your account is in.
- Sign into your Stitch account, if you haven’t already.
- Click User menu (your icon) > Manage Account Settings and locate the Data pipeline region section to verify your account’s region.
-
Locate the list of IP addresses for your region:
- Whitelist the appropriate IP addresses.
- 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
CREATE USER
and GRANT OPTION
privileges 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
CREATE USER
andGRANT OPTION
privileges. -
Run the following command to create the Stitch database user:
CREATE USER '<stitch_username>'@'localhost' IDENTIFIED BY '<password>';
Replace
<password>
with a secure password. If using SSH, this can be different than the SSH password. -
Grant the Stitch user
SELECT
privileges 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 |
SELECT |
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:
-
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 Magento” would create a schema called
stitch_magento
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 Magento instance. For example: This could be a network address such as
192.68.0.1
, or a server endpoint likedbname.hosting-provider.com
. -
Port: Enter the port used by the Magento instance. The default is
3306
. -
Username: Enter the Stitch Magento database user’s username.
-
Password: Enter the password for the Stitch Magento database user.
-
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. (
22
by default) -
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:
-
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 3.4: Save the integration
When finished, click Check and Save.
Stitch will perform a connection test to the Magento 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 4: 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.
For Magento integrations, you can select:
-
Individual tables and columns
-
All tables and columns
Click the tabs to view instructions for each selection method.
- In the Integration Details page, click the Tables to Replicate tab.
- Locate a table you want to replicate.
-
Click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
-
After you set a table to replicate, a page with the table’s columns will display. De-select columns if needed.
- Next, you’ll define the table’s Replication Method. Click the Table Settings button.
- In the Table Settings page:
-
Define the table’s Replication Method.
-
If using Key-based Incremental Replication, select a Replication Key.
-
When finished, click Update Settings.
-
-
Repeat this process for every table you want to replicate.
- Click the Finalize Your Selections button at the bottom of the page to save your data selections.
Important: Before using this feature, note that:
-
Using the Select All feature will overwrite any previous selections. However, selections aren’t final until Finalize Your Selections is clicked. Clicking Cancel will restore your previous selections.
-
Log-based Incremental Replication must be enabled and set as the default Replication Method to use the Select All feature.
Refer to the Select All guide for more info about this feature.
- Click into the integration from the Stitch Dashboard page.
-
Click the Tables to Replicate tab.
-
Navigate to the table level, selecting any databases and/or schemas that contain tables you want to replicate.
- In the list of tables, click the box next to the Table Names column.
-
In the menu that displays, click Track AllTables and Fields (Except Views):
- Click the Finalize Your Selections button at the bottom of the page 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.
Related | Troubleshooting |
Questions? Feedback?
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.