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

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

   Connecting to Azure Synapse

   In addition to providing authentication (see below), set the following properties to connect to a Azure Synapse database:

   • Server: The server running Azure. You can find this by logging into the Azure portal and navigating to Azure Synapse Analytics -> Select your database -> Overview -> Server name.
   • Database: The name of the database, as seen in the Azure portal on the Azure Synapse Analytics page.

   Authenticating to Azure Synapse

   Connect to Azure Synapse using the following properties:

   • User: The username provided for authentication with Azure.
   • Password: The password associated with the authenticating user.

   Built-in Connection String Designer

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

   java -jar cdata.jdbc.azuresynapse.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/azuresynapse" auth="Container" type="javax.sql.DataSource" driverClassName="cdata.jdbc.azuresynapse.AzureSynapseDriver" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" url="jdbc:azuresynapse:User=myuser;Password=mypassword;Server=localhost;Database=Northwind;" maxActive="20" maxIdle="10" maxWait="-1" />

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

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

More Tomcat Integration

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