Magento

Magento feature snapshot

A high-level look at Stitch's Magento integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release Status	Released	Supported By	Stitch
Stitch Plan	Free	Supported Versions	n/a
Singer GitHub Repository	Magento 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
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.

Step 2: 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

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

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 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 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 like dbname.hosting-provider.com.

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

   • Username: Enter the Stitch Magento database user’s username.

   • Password: Enter the password for the Stitch Magento 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 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.

1. Click the SSH Tunnel checkbox.

2. 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:

• Replication Frequency

• Anchor Scheduling

• Advanced Scheduling using Cron (Enterprise 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 4: Select data to replicate

The last step is to select 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.

You can select tables and columns by:

1. In the Integration Details page, click the Tables to Replicate tab.
2. Locate a table you want to replicate.
3. Click the checkbox next to the object’s name. A green checkmark means the object is set to replicate.
4. If there are child objects, they’ll automatically display and you’ll be prompted to select some.

5. 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.

6. In the Settings page, define the table’s Replication Method and, if using Key-based Incremental Replication, its Replication Key.

7. Repeat this process for every table you want to replicate.

8. 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.

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
Destination & Integration Compatibility Replication Scheduling Replication Methods Replication Keys	MySQL TINYINT(1)/boolean Columns Stored as BIT MySQL Extraction Errors Database Connection Errors Understanding & Reducing Your Usage Re-Authorizing Integrations Replication Issues

---

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.