Connect to Phoenix Data in as an External Source in Dremio

The CData JDBC Driver for Phoenix implements JDBC Standards and allows various applications, including Dremio, to work with live Phoenix data. Dremio is a data lakehouse platform designed to empower self-service, interactive analytics on the data lake. With the CData JDBC Driver, you can include live Phoenix data as a part of your enterprise data lake. This article describes how to connect to Phoenix data from Dremio as an External Source.

The CData JDBC Driver enables high-speed access to live Phoenix data in Dremio. Once you install the driver, authenticate with Phoenix and gain immediate access to Phoenix data within your data lake. By surfacing Phoenix data using native data types and handling complex filters, aggregations, & other operations automatically, the CData JDBC Driver grants seamless access to Phoenix data.

Build the ARP Connector

To use the CData JDBC Driver in Dremio, you need to build an Advanced Relation Pushdown (ARP) Connector. You can view the source code for the Connector on GitHub or download the ZIP file (GitHub.com) directly. Once you copy or extract the files, run the following command from the root directory of the connector (the directory containing the pom.xml file) to build the connector.

mvn clean install

Once the JAR file for the connector is built (in the target directory), you are ready to copy the ARP connector and JDBC Driver to your Dremio instance.

Installing the Connector and JDBC Driver

Install the ARP Connector to %DREMIO_HOME%/jars/ and the JDBC Driver for Phoenix to %DREMIO_HOME%/jars/3rdparty. You can use commands similar to the following:

ARP Connector

docker cp PATH\TO\dremio-apachephoenix-plugin-20.0.0.jar dremio_image_name:/opt/dremio/jars/

JDBC Driver for Phoenix

docker cp PATH\TO\cdata.jdbc.apachephoenix.jar dremio_image_name:/opt/dremio/jars/3rdparty/

Connecting to Phoenix

Phoenix will now appear as an External Source option in Dremio. The ARP Connector built uses a JDBC URL to connect to Phoenix data. The JDBC Driver has a built-in connection string designer that you can use (see below).

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Phoenix JDBC Driver. 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.

NOTE: To use the JDBC Driver in Dremio, you will need a license (full or trial) and a Runtime Key (RTK). For more information on obtaining this license (or a trial), contact our sales team.

Add the Runtime Key (RTK) to the JDBC URL. You will end up with a JDBC URL similar to the following:

jdbc:apachephoenix:RTK=5246...;Server=localhost;Port=8765;

Access Phoenix as an External Source

To add Phoenix as an External Source, click to add a new source and select ApachePhoenix. Copy the JDBC URL and paste it into the New ApachePhoenix Source wizard.

Save the connection and you are ready to query live Phoenix data in Dremio, easily incorporating Phoenix data into your data lake.

More Information & Free Trial

Using the CData JDBC Driver for Phoenix in Dremio, you can incorporate live Phoenix data into your data lake. Check out our CData JDBC Driver for Phoenix page for more information about connecting to Phoenix. Download a free, 30 day trial of the CData JDBC Driver for Phoenix and get started today.