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

APPLIES TO: Azure Data Factory Azure Synapse Analytics

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

Supported capabilities

This Square connector is supported for the following capabilities:

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

The connector supports the Windows versions in this article.

Getting started

To perform the Copy activity with a pipeline, you can use one of the following tools or SDKs:

• The Copy Data tool
• The Azure portal
• The .NET SDK
• The Python SDK
• Azure PowerShell
• The REST API
• The Azure Resource Manager template

Create a linked service to Square using UI

Use the following steps to create a linked service to Square 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
   • Azure Synapse

   

2. Search for Square and select the Square connector.

   

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

   

Connector configuration details

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

Linked service properties

The Square connector now supports version 2.0 (Preview). Refer to this section to upgrade your Square connector version from version 1.0. For the property details, see the corresponding sections.

• Version 2.0 (Preview)
• Version 1.0

Version 2.0 (Preview)

The Square linked service supports the following properties when apply version 2.0 (Preview):

Example:

{
    "name": "SquareLinkedService",
    "properties": {
        "type": "Square",
        "version": "2.0",
        "typeProperties": {
            "host": "<e.g. mystore.mysquare.com>", 
            "clientId": "<client ID>", 
            "clientSecret": {
                "type": "SecureString",
                "value": "<clientSecret>"
            }, 
            "accessToken": {
                "type": "SecureString",
                "value": "<access token>"
            }, 
            "refreshToken": {
                "type": "SecureString",
                "value": "<refresh token>"
            }
        }
    }
}

Version 1.0

The Square linked service supports the following properties when apply version 1.0:

Example:

{
    "name": "SquareLinkedService",
    "properties": {
        "type": "Square",
        "typeProperties": {
            "connectionProperties": {
                "host": "<e.g. mystore.mysquare.com>", 
                "clientId": "<client ID>", 
                "clientSecret": {
                    "type": "SecureString",
                    "value": "<clientSecret>"
                }, 
                "accessToken": {
                    "type": "SecureString",
                    "value": "<access token>"
                }, 
                "refreshToken": {
                    "type": "SecureString",
                    "value": "<refresh token>"
                }, 
                "useEncryptedEndpoints": true, 
                "useHostVerification": true, 
                "usePeerVerification": true 
            }
        }
    }
}

Access token types

Square support two types of access token: personal and OAuth.

• Personal access tokens are used to get unlimited Connect API access to resources in your own Square account.

• OAuth access tokens are used to get authenticated and scoped Connect API access to any Square account. Use them when your app accesses resources in other Square accounts on behalf of account owners. OAuth access tokens can also be used to access resources in your own Square account.

  Important

  To perform Test connection in the linked service, MERCHANT_PROFILE_READ is required to get a scoped OAuth access token. For permissions to access other tables, see Square OAuth Permissions Reference.

Authentication via personal access token only needs accessToken, while authentication via OAuth requires accessToken and refreshToken. Learn how to retrieve access token from here.

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

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

Example

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

Square as source

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

Example:

"activities":[
    {
        "name": "CopyFromSquare",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<Square input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "SquareSource",
                "query": "SELECT * FROM Business"
            },
            "sink": {
                "type": "<sink type>"
            }
        }
    }
]

Data type mapping for Square

When you copy data from Square, the following mappings apply from Square's data types to the internal data types used by the service. To learn about how the copy activity maps the source schema and data type to the sink, see Schema and data type mappings.

Lookup activity properties

To learn details about the properties, check Lookup activity.

Square connector lifecycle and upgrade

The following table shows the release stage and change logs for different versions of the Square connector:

Upgrade the Square connector from version 1.0 to version 2.0 (Preview)

1. In Edit linked service page, select 2.0 (Preview) for version. For more information, see linked service version 2.0 (Preview) properties.
2. The data type mapping for the Square linked service version 2.0 is different from that for the version 1.0. To learn the latest data type mapping, see Data type mapping for Square.
3. Self-hosted integration runtime is only supported in version 1.0. You should use the Azure integration runtime instead of self-hosted integration runtime in version 2.0 (Preview).
4. query is only supported in version 1.0. You should use the tableName instead of query in version 2.0 (Preview).

Related content

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