Copy data from Phoenix using Azure Data Factory

This article outlines how to use the Copy Activity in Azure Data Factory to copy data from Phoenix. It builds on the copy activity overview article that presents a general overview of copy activity.

Supported capabilities

You can copy data from Phoenix 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.

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

Getting started

You can create a pipeline with the copy activity by using one of the following tools or SDKs. Select a link to go to a tutorial with step-by-step instructions to create a pipeline with a copy activity.

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

Linked service properties

The following properties are supported for Phoenix linked service:

Property Description Required
type The type property must be set to: Phoenix Yes
host The IP address or host name of the Phoenix server. (that is, 192.168.222.160) Yes
port The TCP port that the Phoenix server uses to listen for client connections. The default value is 8765. If you connect to Azure HDInsights, specify port as 443. No
httpPath The partial URL corresponding to the Phoenix server. (that is, /gateway/sandbox/phoenix/version). The default value is hbasephoenix if using WindowsAzureHDInsightService. No
authenticationType The authentication mechanism used to connect to the Phoenix server.
Allowed values are: Anonymous, UsernameAndPassword, WindowsAzureHDInsightService
Yes
username The user name used to connect to the Phoenix server. No
password The password corresponding to the user name. Mark this field as a SecureString to store it securely in Data Factory, or reference a secret stored in Azure Key Vault. No
enableSsl Specifies whether the connections to the server are encrypted using SSL. The default value is false. No
trustedCertPath The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR. No
useSystemTrustStore Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. No
allowHostNameCNMismatch Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false. No
allowSelfSignedServerCert Specifies whether to allow self-signed certificates from the server. The default value is false. No
connectVia The Integration Runtime to be used to connect to the data store. You can use Self-hosted Integration Runtime or Azure Integration Runtime (if your data store is publicly accessible). If not specified, it uses the default Azure Integration Runtime. No

Example:

{
    "name": "PhoenixLinkedService",
    "properties": {
        "type": "Phoenix",
        "typeProperties": {
            "host" : "<cluster>.azurehdinsight.net",
            "port" : "443",
            "httpPath" : "hbasephoenix",
            "authenticationType" : "WindowsAzureHDInsightService",
            "username" : "<username>",
            "password": {
                 "type": "SecureString",
                 "value": "<password>"
            }
        }
    }
}

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

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

Example

{
    "name": "PhoenixDataset",
    "properties": {
        "type": "PhoenixObject",
        "linkedServiceName": {
            "referenceName": "<Phoenix 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 Phoenix source.

PhoenixSource as source

To copy data from Phoenix, set the source type in the copy activity to PhoenixSource. 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: PhoenixSource Yes
query Use the custom SQL query to read data. For example: "SELECT * FROM MyTable". Yes

Example:

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

Next steps

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