Zoomdata Version

Connecting to Apache Phoenix

Zoomdata is able to connect to Apache Phoenix v4.5 , v4.7 and Phoenix Query Server v4.7 out of the box. To connect to Apache Phoenix 4.4, contact Support for more information about how to obtain the connector.


Before you can establish a connection from Zoomdata to Apache Phoenix, a Phoenix connector server needs to be installed, configured and enabled first by the Zoomdata Account Administrator.

Starting with version 2.3, Zoomdata's architecture has been enhanced to enable the deployment of new connectors as standalone components running in their own process space. To learn more and access the setup instructions, refer to the article Configuring a New Connector Manually .

The table below lists information on the features that are supported by Apache Phoenix (v4.4, v4.5, and v4.7):

Supports Distinct Count? Yes
Supports Live Mode/ Playback? No
SparkIt Capable? Yes
Supports Group-by Time? Yes
Supports Multi Group-by Charts? Yes
Supports Histogram? Yes
Supports Box Plot? No
Custom SQL Capable? No
Supports Last Value? No
Supports Partition? No


For details about what is provided on each page of the connection process, review the article Source Connection Workflow. Depending on your needs, you can either follow the steps in order from start to finish or jump to a specific section in the connection process:


  1. Log into Zoomdata.
  1. Select the Sources menu item.

Figure 1

  1. Select the required Apache Phoenix connector icon.

General Page

  1. Specify the name of your source and add a description (if desired).

Figure 2

  1. Select Next to continue to the next setup page.

Connection Page

This page defines the connection source for Zoomdata to be able to access the data source. If this is the first time setting up a connection, then you need to input the necessary credentials. If a validated connection already exists, you are given the option to use it.

  1. To create a new connection, select the Input New Credentials option.
  2. Enter a unique name for the connection (to help distinguish between other connections in this Zoomdata account).
    Specify the JDBC URL.
    • For Apache Phoenix v4.5 and 4.7, specify the JDBC URL in following format:
      • zk_quorum is a comma separated list of the ZooKeeper Servers
      • zk_port is the ZooKeeper port
      • zk_hbase_path is the path used by Hbase to stop information about the instance
    • For Phoenix Query Server, specify the JDBC URL in following format:
      • scheme is a transport protocol for communication with the server
      • server-hostname is the name of the host offering the service
      • port is the port number on which the host is listening
  1. If authentication has been set up, provide the User Name and Password.
  2. Select Validate .
    If successfully validated, the connection is saved.

Figure 3

  1. Select Next to continue to the next setup page.

Tables Page

The Tables page lets you select the schema and collection to connect with and provides a preview of the selected table. In addition, caching options and toggling the availability of the fields can be done on this page.

  1. Select the schema, if available, and then select the desired collection to connect to Zoomdata.
  2. Create a Custom SQL query, if needed.
Caveats for using Custom SQL in Phoenix:
- Due to the structure of Phoenix sources, Zoomdata recommends using aliases in your queries for this connection.
- Not all statements are handled by Phoenix, for example, GROUP BY and HAVING.
- Subqueries are not handled.
Zoomdata will wrap your SQL query into a SELECT statement. If specific statements inside the wrapped query are not supported by your data source, the query will not be executed.
  1. Toggle the caching options (SparkIt and Caching), as needed.
Spark It capability is planned for deprecation in a future release.
  1. Toggle the availability of the fields, as needed.
  2. Select Next to continue.

Figure 4

Fields Page

The Fields page lets you (1) configure attribute options, (2) create custom labels for the fields in your data source (that will be displayed in the charts), (3) manage the Volume metric, and (4) work with Calculations.

  1. Determine whether the field should be visible or not to the user.
  2. Create unique label names, as needed, for each Label field.
When you create a data source, the specific number of distinct values for the attribute fields are saved in Zoomdata depending on the data sample from your data set. You can filter the data on your chart by these values. While editing a data source, if you want to use all distinct values in the filter (that is from whole data source), select the Refresh button in the Statistics column.
  1. For the Type column, you have the option to edit the field type (although usually you won't need to do this).
  2. For the Configure column, numeric and time-based fields may be edited:
    • Numeric types including Money, Number and Integer - ability to select a default aggregation function
    • Time fields - ability to define the default time pattern and granularity; if the time field provides granularities of hour, minute and second, then a time zone label may be applied
  3. Select fields for Distinct Counts as needed.
  4. Refresh the connection to a particular field, as desired.
  5. Configure Filter Display settings for fields.
  6. Edit the Volume Metric settings, as needed.
  7. Work with Calculations, if available and as needed.
    If you are setting up a new connection, the Calculations section will not be available until after the connection is saved.
  8. Select Next to continue.

Figure 5 ​​

Refresh Page

The Refresh page lets you schedule asynchronous jobs to update the source metadata. For guidance to set up a refresh schedule, refer to the article Using the Zoomdata Scheduler .

Charts Page

On the Charts page, you can:

  1. Edit Global Default Settings
  2. Select the Standard and, if available, Custom chart styles to be used with the data source
  3. Set default parameters (group, sub-group, colors, sorting, and so on) for each chart style

Figure 6

Learn more about how to customize a chart .

Select Finish to save your changes. Once your data connection has been established, it is listed under the My Data Sources section of the page.