Skip to content

Files

Latest commit

2bc81fc · Apr 18, 2022

History

History
194 lines (146 loc) · 7.33 KB

connector-mariadb.md

File metadata and controls

194 lines (146 loc) · 7.33 KB
title description titleSuffix author ms.service ms.subservice ms.custom ms.topic ms.date ms.author
Copy data from MariaDB
Learn how to copy data from MariaDB to supported sink data stores using a copy activity in an Azure Data Factory or Synapse Analytics pipeline.
Azure Data Factory & Azure Synapse
jianleishen
data-factory
data-movement
synapse
conceptual
04/18/2022
jianleishen

Copy data from MariaDB using Azure Data Factory or Synapse Analytics

[!INCLUDEappliesto-adf-asa-md]

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

Supported capabilities

This MariaDB connector is supported for the following activities:

You can copy data from MariaDB to any supported sink data store. For a list of data stores that are supported as sources/sinks by the copy activity, 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.

This connector currently supports MariaDB of version 10.0 to 10.5.

Prerequisites

[!INCLUDE data-factory-v2-integration-runtime-requirements]

Getting started

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

Create a linked service to MariaDB using UI

Use the following steps to create a linked service to MariaDB 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:

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

    :::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 Maria and select the MariaDB connector.

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

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

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

Connector configuration details

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

Linked service properties

The following properties are supported for MariaDB linked service:

Property Description Required
type The type property must be set to: MariaDB Yes
connectionString An ODBC connection string to connect to MariaDB.
You can also put password in Azure Key Vault and pull the pwd configuration out of the connection string. Refer to the following samples and Store credentials in Azure Key Vault article with more details.
Yes
connectVia The Integration Runtime to be used to connect to the data store. Learn more from Prerequisites section. If not specified, it uses the default Azure Integration Runtime. No

Example:

{
    "name": "MariaDBLinkedService",
    "properties": {
        "type": "MariaDB",
        "typeProperties": {
            "connectionString": "Server=<host>;Port=<port>;Database=<database>;UID=<user name>;PWD=<password>"
        },
        "connectVia": {
            "referenceName": "<name of Integration Runtime>",
            "type": "IntegrationRuntimeReference"
        }
    }
}

Example: store password in Azure Key Vault

{
    "name": "MariaDBLinkedService",
    "properties": {
        "type": "MariaDB",
        "typeProperties": {
            "connectionString": "Server=<host>;Port=<port>;Database=<database>;UID=<user name>;",
            "pwd": { 
                "type": "AzureKeyVaultSecret", 
                "store": { 
                    "referenceName": "<Azure Key Vault linked service name>", 
                    "type": "LinkedServiceReference" 
                }, 
                "secretName": "<secretName>" 
            }
        },
        "connectVia": {
            "referenceName": "<name of Integration Runtime>",
            "type": "IntegrationRuntimeReference"
        }
    }
}

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 MariaDB dataset.

To copy data from MariaDB, set the type property of the dataset to MariaDBTable. There is no additional type-specific property in this type of dataset.

Example

{
    "name": "MariaDBDataset",
    "properties": {
        "type": "MariaDBTable",
        "typeProperties": {},
        "schema": [],
        "linkedServiceName": {
            "referenceName": "<MariaDB 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 MariaDB source.

MariaDB as source

To copy data from MariaDB, set the source type in the copy activity to MariaDBSource. 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: MariaDBSource Yes
query Use the custom SQL query to read data. For example: "SELECT * FROM MyTable". No (if "tableName" in dataset is specified)

Example:

"activities":[
    {
        "name": "CopyFromMariaDB",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<MariaDB input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "MariaDBSource",
                "query": "SELECT * FROM MyTable"
            },
            "sink": {
                "type": "<sink type>"
            }
        }
    }
]

Lookup activity properties

To learn details about the properties, check Lookup activity.

Next steps

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