Configure the CData JDBC Driver for Databricks in 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 Databricks data from a connection pool in Tomcat.

Getting Started

---

Connect to Databricks 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.

   To connect to a Databricks cluster, set the properties as described below.

   Note: The needed values can be found in your Databricks instance by navigating to Clusters, and selecting the desired cluster, and selecting the JDBC/ODBC tab under Advanced Options.

   • Server: Set to the Server Hostname of your Databricks cluster.
   • HTTPPath: Set to the HTTP Path of your Databricks cluster.
   • Token: Set to your personal access token (this value can be obtained by navigating to the User Settings page of your Databricks instance and selecting the Access Tokens tab).

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Databricks JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   java -jar cdata.jdbc.databricks.jar
   

   Fill in the connection properties and copy the connection string to the clipboard.

   👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
   

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

   <Resource name="jdbc/databricks" auth="Container" type="javax.sql.DataSource" driverClassName="cdata.jdbc.databricks.DatabricksDriver" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" url="jdbc:databricks:Server=127.0.0.1;Port=443;TransportMode=HTTP;HTTPPath=MyHTTPPath;UseSSL=True;User=MyUser;Password=MyPassword;" maxActive="20" maxIdle="10" maxWait="-1" />
   

   To allow a single application to access Databricks 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 Databricks for all applications.

3. Add a reference to the resource to the web.xml for the application.

    Databricks data JSP
    jdbc/Databricks
    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/Databricks");
   Connection conn = ds.getConnection();
    

More Tomcat Integration

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