Manage Phoenix Data in DBArtisan as a JDBC Source

The CData JDBC Driver for Phoenix seamlessly integrates Phoenix data into database management tools like DBArtisan by enabling you to access Phoenix data as a database. This article shows how to create a JDBC source for Phoenix in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate Phoenix Data into DBArtisan Projects

Follow the steps below to register Phoenix data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory. 👁 The JDBC driver definition in the Register Datasource wizard. (Salesforce is shown.)
   
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   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.

   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.

   👁 Required JDBC connection properties in the Register Datasource wizard. (Salesforce is shown.)
   

   Below is a typical connection string:

   jdbc:apachephoenix:Server=localhost;Port=8765;

6. Finish the wizard to connect to Phoenix data. Phoenix entities are displayed in the Datasource Explorer.

You can now work with Phoenix data as you work with any other database. See the driver help documentation for more information on the queries supported by the Phoenix API.