Ready to get started?

Download a free trial of the Phoenix Driver to get started:

 Download Now

Learn more:

Apache Phoenix Icon Phoenix JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with HBase through Apache Phoenix.

Connect to Phoenix Data in HULFT Integrate



Connect to Phoenix as a JDBC data source in HULFT Integrate

HULFT Integrate is a modern data integration platform that provides a drag-and-drop user interface to create cooperation flows, data conversion, and processing so that complex data connections are easier than ever to execute. When paired with the CData JDBC Driver for Phoenix, HULFT Integrate can work with live Phoenix data. This article walks through connecting to Phoenix and moving the data into a CSV file.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Phoenix data. When you issue complex SQL queries to Phoenix, the driver pushes supported SQL operations, like filters and aggregations, directly to Phoenix and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Phoenix data using native data types.

Enable Access to Phoenix

To enable access to Phoenix data from HULFT Integrate projects:

  1. Copy the CData JDBC Driver JAR file (and license file if it exists), cdata.jdbc.apachephoenix.jar (and cdata.jdbc.apachephoenix.lic), to the jdbc_adapter subfolder for the Integrate Server
  2. Restart the HULFT Integrate Server and launch HULFT Integrate Studio

Build a Project with Access to Phoenix Data

Once you copy the JAR files, you can create a project with access to Phoenix data. Start by opening Integrate Studio and creating a new project.

  1. Name the project
  2. Ensure the "Create script" checkbox is checked
  3. Click Next
  4. Name the script (e.g.: ApachePhoenixtoCSV)

Once you create the project, add components to the script to copy Phoenix data to a CSV file.

Configure an Execute Select SQL Component

Drag an "Execute Select SQL" component from the Tool Palette (Database -> JDBC) into the Script workspace.

  1. In the "Required settings" tab for the Destination, click "Add" to create a new connection for Phoenix. Set the following properties:
    • Name: Phoenix Connection Settings
    • Driver class name: cdata.jdbc.apachephoenix.ApachePhoenixDriver
    • URL: jdbc:apachephoenix:Server=localhost;Port=8765;

      Built-in Connection String Designer

      For assistance constructing the JDBC URL, use the connection string designer built into the Phoenix JDBC Driver. Either double-click the JAR file or execute the JAR file from the command-line.

      java -jar cdata.jdbc.apachephoenix.jar

      Fill in the connection properties and copy the connection string to the clipboard.

      Connect to Apache Phoenix via the Phoenix Query Server. Set the Server and Port (if different from the default port) properties to connect to Apache Phoenix. The Server property will typically be the host name or IP address of the server hosting Apache Phoenix.

      Authenticating to Apache Phoenix

      By default, no authentication will be used (plain). If authentication is configured for your server, set AuthScheme to NEGOTIATE and set the User and Password properties (if necessary) to authenticate through Kerberos.

  2. Write your SQL statement. For example:
    SELECT Id, Column1 FROM MyTable
  3. Click "Extraction test" to ensure the connection and query are configured properly
  4. Click "Execute SQL statement and set output schema"
  5. Click "Finish"

Configure a Write CSV File Component

Drag a "Write CSV File" component from the Tool Palette (File -> CSV) onto the workspace.

  1. Set a file to write the query results to (e.g. MyTable.csv)
  2. Set "Input data" to the "Select SQL" component
  3. Add columns for each field selected in the SQL query
  4. In the "Write settings" tab, check the checkbox to "Insert column names into first row"
  5. Click "Finish"

Map Phoenix Fields to the CSV Columns

Map each column from the "Select" component to the corresponding column for the "CSV" component.

Finish the Script

Drag the "Start" component onto the "Select" component and the "CSV" component onto the "End" component. Build the script and run the script to move Phoenix data into a CSV file.

Download a free, 30-day trial of the CData JDBC Driver for Phoenix and start working with your live Phoenix data in HULFT Integrate. Reach out to our Support Team if you have any questions.