Ready to get started?

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

 Download Now

Learn more:

Apache Phoenix Icon Phoenix JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with HBase through Apache Phoenix.

Configure the CData JDBC Driver for Phoenix in a Connection Pool in Tomcat



Connect to Phoenix data from a connection pool in Tomcat.

The CData JDBC Drivers support standard JDBC interfaces to integrate with Web applications running on the JVM. This article details how to connect to Phoenix data from a connection pool in Tomcat.

Connect to Phoenix Data through a Connection Pool in Tomcat

  1. Copy the CData JAR and CData .lic file to $CATALINA_HOME/lib. The CData JAR is located in the lib subfolder of the installation directory.
  2. Add a definition of the resource to the context. Specify the JDBC URL here.

    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.

    You can see the JDBC URL specified in the resource definition below.

    <Resource name="jdbc/apachephoenix" auth="Container" type="javax.sql.DataSource" driverClassName="cdata.jdbc.apachephoenix.ApachePhoenixDriver" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" url="jdbc:apachephoenix:Server=localhost;Port=8765;" maxActive="20" maxIdle="10" maxWait="-1" />

    To allow a single application to access Phoenix data, add the code above to the context.xml in the application's META-INF directory.

    For a shared resource configuration, add the code above to the context.xml located in $CATALINA_BASE/conf. A shared resource configuration provides connectivity to Phoenix for all applications.

  3. Add a reference to the resource to the web.xml for the application. Phoenix data JSP jdbc/ApachePhoenix javax.sql.DataSource Container
  4. Initialize connections from the connection pool: Context initContext = new InitialContext(); Context envContext = (Context)initContext.lookup("java:/comp/env"); DataSource ds = (DataSource)envContext.lookup("jdbc/ApachePhoenix"); Connection conn = ds.getConnection();

More Tomcat Integration

The steps above show how to connect to Phoenix data in a simple connection pooling scenario. For more use cases and information, see the JNDI Datasource How-To in the Tomcat documentation.