Skip to content

connector-magento.md

Latest commit

 

History

History
180 lines (135 loc) · 7.03 KB

connector-magento.md

File metadata and controls

180 lines (135 loc) · 7.03 KB
title Copy data from Magento (Preview)
description Learn how to copy data from Magento to supported sink data stores using a copy activity in an Azure Data Factory or Synapse Analytics pipeline.
titleSuffix Azure Data Factory & Azure Synapse
author jianleishen
ms.subservice data-movement
ms.topic how-to
ms.date 01/26/2025
ms.author jianleishen
ms.custom
synapse
sfi-image-nochange

Copy data from Magento using Azure Data Factory or Synapse Analytics(Preview)

[!INCLUDEappliesto-adf-asa-md]

Important

This connector is at End of Support stage. You are recommended to migrate to ODBC connector by installing a driver.

This article outlines how to use the Copy Activity in an Azure Data Factory or Synapse Analytics pipeline to copy data from Magento. It builds on the copy activity overview article that presents a general overview of copy activity.

Supported capabilities

This Magento connector is supported for the following capabilities:

Supported capabilities IR
Copy activity (source/-) ① ②
Lookup activity ① ②

① Azure integration runtime ② Self-hosted integration runtime

For a list of data stores that are supported as sources/sinks, see the Supported data stores table.

The service provides a built-in driver to enable connectivity, therefore you don't need to manually install any driver using this connector.

Getting started

[!INCLUDE data-factory-v2-connector-get-started]

Create a linked service to Magento using UI

Use the following steps to create a linked service to Magento in the Azure portal UI.

  1. Browse to the Manage tab in your Azure Data Factory or Synapse workspace and select Linked Services, then click New:

    Azure Data Factory

    :::image type="content" source="media/doc-common-process/new-linked-service.png" alt-text="Screenshot of creating a new linked service with Azure Data Factory UI.":::

    Azure Synapse

    :::image type="content" source="media/doc-common-process/new-linked-service-synapse.png" alt-text="Screenshot of creating a new linked service with Azure Synapse UI.":::

  2. Search for Magento and select the Magento connector.

    :::image type="content" source="media/connector-magento/magento-connector.png" alt-text="Screenshot of the Magento connector.":::

  3. Configure the service details, test the connection, and create the new linked service.

    :::image type="content" source="media/connector-magento/configure-magento-linked-service.png" alt-text="Screenshot of linked service configuration for Magento.":::

Connector configuration details

The following sections provide details about properties that are used to define Data Factory entities specific to Magento connector.

Linked service properties

The following properties are supported for Magento linked service:

Property Description Required
type The type property must be set to: Magento Yes
host The URL of the Magento instance. (that is, 192.168.222.110/magento3) Yes
accessToken The access token from Magento. Mark this field as a SecureString to store it securely, or reference a secret stored in Azure Key Vault. Yes
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. No
useHostVerification Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over TLS. The default value is true. No
usePeerVerification Specifies whether to verify the identity of the server when connecting over TLS. The default value is true. No

Example:

{
    "name": "MagentoLinkedService",
    "properties": {
        "type": "Magento",
        "typeProperties": {
            "host" : "192.168.222.110/magento3",
            "accessToken": {
                "type": "SecureString",
                "value": "<accessToken>"
            },
            "useEncryptedEndpoints" : true,
            "useHostVerification" : true,
            "usePeerVerification" : true
        }
    }
}

Dataset properties

For a full list of sections and properties available for defining datasets, see the datasets article. This section provides a list of properties supported by Magento dataset.

To copy data from Magento, set the type property of the dataset to MagentoObject. The following properties are supported:

Property Description Required
type The type property of the dataset must be set to: MagentoObject Yes
tableName Name of the table. No (if "query" in activity source is specified)

Example

{
    "name": "MagentoDataset",
    "properties": {
        "type": "MagentoObject",
        "typeProperties": {},
        "schema": [],
        "linkedServiceName": {
            "referenceName": "<Magento linked service name>",
            "type": "LinkedServiceReference"
        }
    }
}

Copy activity properties

For a full list of sections and properties available for defining activities, see the Pipelines article. This section provides a list of properties supported by Magento source.

Magento as source

To copy data from Magento, set the source type in the copy activity to MagentoSource. The following properties are supported in the copy activity source section:

Property Description Required
type The type property of the copy activity source must be set to: MagentoSource Yes
query Use the custom SQL query to read data. For example: "SELECT * FROM Customers". No (if "tableName" in dataset is specified)

Example:

"activities":[
    {
        "name": "CopyFromMagento",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<Magento input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "MagentoSource",
                "query": "SELECT * FROM Customers where Id > XXX"
            },
            "sink": {
                "type": "<sink type>"
            }
        }
    }
]

Lookup activity properties

To learn details about the properties, check Lookup activity.

Related content

For a list of data stores supported as sources and sinks by the copy activity, see supported data stores.