Apache Phoenix

Version 24.1.8910


Apache Phoenix


You can use the Apache Phoenix connector from the CData Sync application to capture data from Apache Phoenix and move it to any supported destination. To do so, you need to add the connector, authenticate to the connector, and complete your connection.

Add the Apache Phoenix Connector

To enable Sync to use data from Apache Phoenix, you first must add the connector, as follows:

  1. Open the Connections page of the Sync dashboard.

  2. Click Add Connection to open the Select Connectors page.

  3. Click the Sources tab and locate the Apache Phoenix row.

  4. Click the Configure Connection icon at the end of that row to open the New Connection page. If the Configure Connection icon is not available, click the Download Connector icon to install the Apache Phoenix connector. For more information about installing new connectors, see Connections.

Start the Apache Phoenix Query Server

Before you connect, you need to ensure that the Apache Phoenix Query Server is running. Different versions of the server contain different interfaces, different means of starting and stopping the server, and different default port settings. In most distributions, you can start the server in the background by submitting the following command:

queryserver.py start

This method requires that you are running an instance of Apache HBase and, possibly, Apache ZooKeeper as well. For more details, see the documentation for your server version.

Authenticate to Apache Phoenix

After you add the connector, you need to set the required properties.

  • Connection Name - Enter a connection name of your choice.

  • URL - Enter the URL to your instance of Apache Phoenix (for example, http://localhost:8765).

CData Sync supports authenticating to Apache Phoenix in several ways. Select your authentication method below to proceed to the relevant section that contains the authentication details.

None

To connect without authentication, select None for Auth Scheme. No additional properties are required.

Basic

To connect with your user credentials, set the following properties:

  • Auth Scheme: Select Basic.

  • User - Enter the username that you use to authenticate to your Apache Phoenix account.

  • Password - Enter the password that you use to authenticate to your Apache Phoenix account.

Negotiate

To connect with Kerberos credentials, specify the following properties:

  • Auth Scheme – Select Negotiate.

  • Kerberos KDC - Enter the Kerberos Key Distribution Center (KDC) service that you use to authenticate.

  • Kerberos Realm - Enter the Kerberos Realm that you use to authenticate.

  • Kerberos SPN - Enter the service principal name (SPN) for the Kerberos domain controller.

  • Kerberos Keytab File (optional) - Enter the keytab file that contains your pairs of the Kerberos principals and encrypted keys.

  • Kerberos Ticket Cache (optional) - Enter the full file path to the Kerberos credential cache file.

Azure HDInsight

To connect with Azure HDInsight, specify the following properties:

  • Auth Scheme – Select AzureHDInsight.

  • User - Enter the username that you use to authenticate to your Apache Phoenix account.

  • Password - Enter the password that you use to authenticate to your Apache Phoenix account.

  • Cluster Name - Enter the name of the cluster that contains your Azure HDInsight instance.

Complete Your Connection

To complete your connection:

  1. For Version (optional), enter the version of your Apache Phoenix instance. The default version is 4.9.0.

  2. Define advanced connection settings on the Advanced tab. (In most cases, though, you should not need these settings.)

  3. Click Create & Test to create your connection.

More Information

For more information about interactions between CData Sync and Apache Phoenix, see Apache Phoenix Connector for CData Sync.