Ready to get started?

Learn more about the CData JDBC Driver for Phoenix or download a free trial:

Download Now

Connect to Phoenix Data in Squirrel SQL Client

Connect to Phoenix data and execute queries in the Squirrel SQL Client.

The CData JDBC Driver for Phoenix enables you to execute queries to Phoenix data in tools like Squirrel SQL Client. In this article, you will create a JDBC data source for Phoenix data and execute queries.

Add the JDBC Driver for Phoenix

Follow the steps below to add the driver JAR.

  1. In Squirrel SQL, click Windows -> View Drivers.
  2. Click the plus icon to open the Add Driver wizard.
  3. In the Name box, enter a user-friendly name for the driver; for example, CData JDBC Driver for Phoenix.
  4. In the Example URL box, enter jdbc:apachephoenix:
  5. In the Extra Class Path tab, click Add.
  6. In the file explorer dialog that opens, select the JAR file for the driver, located in the lib subfolder of the installation directory.
  7. Click List Drivers to populate the Class Name menu with the class name for the driver, cdata.jdbc.apachephoenix.ApachePhoenixDriver.

Define Connection Properties

Follow the steps below to save connection properties in the driver alias.

  1. Click Windows -> View Aliases.
  2. In the pane that lists the aliases, click the plus icon.
  3. In the Add Alias wizard that opens, the following fields are required for the JDBC driver:

    • Name: Enter a name for the alias; for example, CData Phoenix Source.
    • Driver: Select the CData JDBC Driver for Phoenix.
    • URL: Enter jdbc:apachephoenix:
  4. If you want to define any additional properties, click Properties.
  5. In the Driver properties tab of the dialog that appears, select the Use driver properties checkbox.
  6. In the Specify column, select the checkboxes for the required 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.

    Below is a typical connection string:

    jdbc:apachephoenix:Server=localhost;Port=8765;
  7. In the dialog that appears after you click OK, click connect to test the connection.

Discover Schemas and Query Phoenix Data

After the metadata has loaded, a new tab for the Phoenix data source is displayed. On the Objects subtab, you can discover schema information, such as the available tables and views.

To view table data, select the table on the Objects tab. The table data is then loaded in a grid on the Content tab.

To execute an SQL query, enter the query on the SQL tab and then click Run SQL (the runner icon). For example:

SELECT Id, Column1 FROM MyTable WHERE Id = '123456'