Magento - Hevo Data

Magento Setup Guide

Magento empowers thousands of retailers and brands with the best eCommerce platform and flexible cloud solutions to rapidly innovate and grow. It offers marketing, search engine optimization, and catalog-management tools.

Magento Platform uses MySQL database as an underlying data store. Hevo connects directly to Magento’s MySQL database rather than connecting through the APIs. This approach ensures most comprehensive coverage in terms of data and more reliability.

You can replicate the Events data from your Magento account to a Destination database or Data Warehouse using Hevo Pipelines.

Getting Started

Setup

Prerequisites

Database credentials of the MySQL database used by Magento. Read more about creating a database for Magento.
Hevo’s IP addresses are whitelisted.
SELECT privileges are granted to the database user.
You are assigned the Team Administrator, Team Collaborator, or Pipeline Administrator role in Hevo to create the Pipeline.

Perform the following steps to configure Magento via MySQL as the Source in your Pipeline. You must provide details of the MySQL database to configure the Magento Source.

Whitelist Hevo’s IP Addresses

Click your MySQL variant below for steps to whitelist Hevo’s IP address:

Grant Privileges to the User

Perform the following steps to grant the SELECT privilege to the database user:

Log in to your MySQL database instance as a root user. For example, mysql -u root -p.
Run the following command to grant SELECT privilege to the new database user:
GRANT SELECT ON *.* TO 'username'; # to grant privileges to a user with <username> as username

Specify Magento via MySQL Connection Settings

Perform the following steps to configure Magento via MySQL as the Source in your Pipeline:

Click PIPELINES in the Navigation Bar.
Click + CREATE PIPELINE in the Pipelines List View.
On the Select Source Type page, select Magento via MySQL.
On the Configure your Magento via MySQL Source page, specify the following:
- Pipeline Name: A unique name for your Pipeline, not exceeding 255 characters.
- Database Host: The MySQL host’s IP address or DNS.
  
  Note: For URL-based hostnames, exclude the http:// or https:// part. For example, if the hostname URL is http://mysql-replica.westeros.inc/, enter mysql-replica.westeros.inc.
- Database Port: The port on which your MySQL server listens for connections. Default value: 3306.
- Database User: The authenticated user that can read the tables in your database.
- Database Password: Password for the database user.
- Database Name: The database you want to load data from, if the Pipeline mode is Table or Custom SQL.
- Connection Settings
  - Connect through SSH: Enable this option to connect to Hevo using an SSH tunnel, instead of directly connecting your MySQL database host to Hevo. This provides an additional level of security to your database by not exposing your MySQL setup to the public. Read Connecting Through SSH.
    
    If this option is disabled, you must whitelist Hevo’s IP addresses. Refer to the content for your MySQL variant for steps to do this.
  - Use SSL: Enable it to use SSL encrypted connection. To enable this, specify the following:
    - CA File: The file containing the SSL server certificate authority (CA).
      - Load all CA Certificates: If selected, Hevo loads all CA certificates (up to 50) from the uploaded CA file, else it loads only the first certificate.
        
        Note: Select this check box if you have more than one certificate in your CA file.
    - Client Certificate: The client public key certificate file.
    - Client Key: The client private key file.
Click TEST & CONTINUE to proceed for setting up the Destination. This button is enabled once you specify all the mandatory fields.

Schema and Primary Keys

The schema is derived based on the data in your MySQL Source tables.

Data Model

The data model depends on the data in your MySQL Source tables.

Limitations

Hevo does not load an Event into the Destination table if its size exceeds 128 MB, which may lead to discrepancies between your Source and Destination data. To avoid such a scenario, ensure that each row in your Source objects contains less than 100 MB of data.

Revision History

Refer to the following table for the list of key updates made to this page:

Date	Release	Description of Change
Jan-07-2025	NA	Added a limitation about Event size.
Mar-18-2024	2.21.2	Updated section, Specify Magento via MySQL Connection Settings to add information about the Load all CA certificates option.
Dec-19-2022	2.04	Updated section, Specify Magento via MySQL Connection Settings to add information that you must specify all fields to create a Pipeline.
Jan-24-2022	1.80	New document.

Last updated on Jan 07, 2025