Query Phoenix Data in DataGrip

DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData JDBC Driver for Phoenix, DataGrip can work with live Phoenix data. This article shows how to establish a connection to Phoenix data in DataGrip.

Create a New Driver Definition for Phoenix

The steps below describe how to create a new Data Source in DataGrip for Phoenix.

1. In DataGrip, click File -> New > Project and name the project
2. In the Database Explorer, click the plus icon () and select Driver.
3. In the Driver tab:
   • Set Name to a user-friendly name (e.g. "CData Phoenix Driver")
   • Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.apachephoenix.jar).
   • Set Class to cdata.jdbc.apachephoenix.ApachePhoenix.jar
   Additionally, in the advanced tab you can change driver properties and some other settings like VM Options, VM environment, VM home path, DBMS, etc
   • For most cases, change the DBMS type to "Unknown" in Expert options to avoid native SQL Server queries (Transact-SQL), which might result in an invalid function error
4. Click "Apply" then "OK" to save the Connection

Configure a Connection to Phoenix

1. Once the connection is saved, click the plus (), then "Data Source" then "CData Phoenix Driver" to create a new Phoenix Data Source.
2. In the new window, configure the connection to Phoenix with a JDBC URL.

   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.

   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.

3. Set URL to the connection string, e.g., jdbc:apachephoenix:Server=localhost;Port=8765;
4. Click "Apply" and "OK" to save the connection string

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against Phoenix

To browse through the Phoenix entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

To execute queries, right click on any table and select "New" -> "Query Console."

In the Console, write the SQL query you wish to execute. For example: SELECT Id, Column1 FROM MyTable WHERE Id = '123456'

Download a free, 30-day trial of the CData JDBC Driver for Phoenix and start working with your live Phoenix data in DataGrip. Reach out to our Support Team if you have any questions.