Ready to get started?

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

 Download Now

Learn more:

Apache Phoenix Icon Phoenix ODBC Driver

The Phoenix ODBC Driver is a powerful tool that allows you to connect with HBase through Apache Phoenix, directly from any applications that support ODBC connectivity.

Access Phoenix like you would a relational database - read, write, and update through a standard ODBC Driver interface.

How to Query Phoenix Data in MySQL Workbench



Execute MySQL queries against live Phoenix data from MySQL Workbench.

You can use the SQL Gateway from the ODBC Driver for Phoenix to query Phoenix data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live Phoenix data in MySQL Workbench.

Connect to Phoenix Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Phoenix data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Creating a MySQL Remoting Service in SQL Gateway (Salesforce is shown)

Query Phoenix from MySQL Workbench

The steps below outline connecting to the virtual Phoenix database created in the SQL Gateway from MySQL Workbench and issuing basic queries to work with live Phoenix data.

Connect to Phoenix through the SQL Gateway

  1. In MySQL Workbench, click to add a new MySQL connection.
  2. Name the connection (CData SQL Gateway for Phoenix).
  3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
  4. Click Store in Vault to set and store the password.
  5. Click Test Connection to ensure the connection is configured properly and click OK.

Query Phoenix Data

  1. Open the connection you just created (CData SQL Gateway for Phoenix).
  2. Click File -> New Query Tab.
  3. Write a SQL query to retrieve Phoenix data, like SELECT * FROM `CData ApachePhoenix Sys`.MyTable;

With access to live Phoenix data from MySQL Workbench, you can easily query and update Phoenix, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData ODBC Driver for Phoenix and the CData SQL Gateway.