Ready to get started?

Download a free trial of the Azure Data Catalog Driver to get started:

 Download Now

Learn more:

Azure Data Catalog Icon Azure Data Catalog JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Azure Data Catalog.

Configure the CData JDBC Driver for Azure Data Catalog in a Connection Pool in Tomcat



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

Connect to Azure Data Catalog 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.

    You can optionally set the following to read the different catalog data returned from Azure Data Catalog.

      CatalogName: Set this to the CatalogName associated with your Azure Data Catalog. To get your Catalog name, navigate to your Azure Portal home page > Data Catalog > Catalog Name

    Connect Using OAuth Authentication

    You must use OAuth to authenticate with Azure Data Catalog. OAuth requires the authenticating user to interact with Azure Data Catalog using the browser. For more information, refer to the OAuth section in the help documentation.

    Built-in Connection String Designer

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

    java -jar cdata.jdbc.azuredatacatalog.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/azuredatacatalog" auth="Container" type="javax.sql.DataSource" driverClassName="cdata.jdbc.azuredatacatalog.AzureDataCatalogDriver" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" url="jdbc:azuredatacatalog:InitiateOAuth=GETANDREFRESH" maxActive="20" maxIdle="10" maxWait="-1" />

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

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

More Tomcat Integration

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