Integrate Phoenix Data in the Pentaho Report Designer

The CData JDBC Driver for Phoenix data enables access to live data from dashboards and reports. This article shows how to connect to Phoenix data as a JDBC data source and publish reports based on Phoenix data in Pentaho.

Connect and Create a Report

1. Copy the JAR file of the driver, located in the lib subfolder of the installation directory, to the \Report-Designer\lib\jdbc\ folder in the Pentaho directory.
2. Run the report-designer.bat file in the \Report-Designer\ folder to open the Report-Designer UI.

3. Create a new data source with the driver by clicking Data -> Add Data Source -> Advanced -> JDBC (Custom) and then creating a new Phoenix connection. In the resulting dialog, configure the connection properties as shown below.

   • Custom Connection URL property: Enter the JDBC URL. This starts with jdbc:apachephoenix: and is followed by a semicolon-separated list of connection properties.

     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.

     Built-in Connection String Designer

     For assistance in 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.

     When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

     Below is a typical JDBC URL:

     jdbc:apachephoenix:Server=localhost;Port=8765;
   • Custom Driver Class Name: Enter cdata.jdbc.apachephoenix.ApachePhoenixDriver.
   • User Name: The username to authenticate with.
   • Password: The password to authenticate with.

Add Phoenix Data to a Report

You are now ready to create a report with Phoenix data.

1. Add the Phoenix source to your report: Click Data -> Add Data Source -> JDBC and select the data source.

2. Configure the query. This article uses the one below:

   SELECT Id, Column1 FROM MyTable WHERE Id = '123456'
3. Drag a chart onto your report and double-click it to edit the chart. Run the report to display the chart. You can use the results of this query to create a simple chart for the MyTable table.
4. Finally, run the report to see the chart.