Follow the instructions below to connect Yellowfin to a Phoenix database.

Yellowfin does not ship with the driver required for this connection due to licensing/paywall reasons. You will need to manually upload the driver through the Plugin Manager.



  1. Click on the Create button and choose the data source option.
  2. Then select the database option.



  3. When the New Connection popup appears, provide a name and description for your database.
  4. Choose Phoenix from the list of available database options. New configuration fields will appear on doing so.



  5. Include Schema in SQL: Select this checkbox to add the schema name when addressing database tables in SQL queries.
  6. Database Host: Enter the single host name of the server or a comma separated Zookeeper Quorum.
  7. Database Port: The TCP/IP port used for this connection.



  8. Path: This field makes up part of the Phoenix connection string. Set your path to HBase root Znode. If you also have a Kerberos authentication system, then you should set the path to: hbase root znode [:kerberos_principal [:path to kerberos keytab] ].

    For further clarification on the Phoenix connection string, refer to this external guide: https://phoenix.apache.org/faq.html#What_is_the_Phoenix_JDBC_URL_syntax


  9. JDBC Driver: The JDBC driver to talk to your Phoenix source.



  10. Username: Enter the username of your database account.
  11. Password: Provide the password of the above account.
  12. Once you have completed your connection information, you will have several options:
    1. Advanced Connection Editor: This will take you to the Data Source page in the Admin Console and allow you to edit all the advanced options available for your database.
    2. Test Connection: This will validate the connection parameters you provided to ensure it can connect to your database. If the connection was successful, a message will appear.
    3. Create View: This will save your connection and get you started on creating a view based on it.
    4. Save & Close: This will allow you to save your connection and close the New Connection popup, returning you to the page you were on previously.
    5. Cancel: This closes the New Connection popup without saving your connection, returning you to the page you were on previously.
  13. We recommend testing the connection, and then saving it by using the Save & Close button.