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

Ready to get started?

Download for a free trial:

Download Now

Learn more:

CockroachDB JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with CockroachDB.



Connect to CockroachDB 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 CockroachDB data from a connection pool in Tomcat.

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

    Set the following to connect to CockroachDB.

    • Server: The host name or IP address of the server.
    • Port: The port number of the CockroachDB server. If not specified, the default port is 26257.
    • Database: The name of the Cockroach database. If not specified, you connect to the user's default database.
    • User: The Cockroach DB user account used to authenticate.
    • Password: The password used to authenticate the user.

    Built-in Connection String Designer

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

    java -jar cdata.jdbc.cockroachdb.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/cockroachdb" auth="Container" type="javax.sql.DataSource" driverClassName="cdata.jdbc.cockroachdb.CockroachDBDriver" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" url="jdbc:cockroachdb:User=root;Password=root;Database=system;Server=localhost;Port=26257" maxActive="20" maxIdle="10" maxWait="-1" />

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

  3. Add a reference to the resource to the web.xml for the application. CockroachDB data JSP jdbc/CockroachDB 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/CockroachDB"); Connection conn = ds.getConnection();

More Tomcat Integration

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