Ready to get started?

Download a free trial of the SQL Server Driver to get started:

 Download Now

Learn more:

Microsoft SQL Server Icon SQL Server Driver

Rapidly create and deploy powerful Java applications that integrate with Microsoft SQL Server.

Configure the CData JDBC Driver for SQL Server in a Connection Pool in Tomcat



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

Connect to SQL Server 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 Microsoft SQL Server

    Connect to Microsoft SQL Server using the following properties:

    • Server: The name of the server running SQL Server.
    • User: The username provided for authentication with SQL Server.
    • Password: The password associated with the authenticating user.
    • Database: The name of the SQL Server database.

    Connecting to Azure SQL Server and Azure Data Warehouse

    You can authenticate to Azure SQL Server or Azure Data Warehouse by setting the following connection properties:

    • Server: The server running Azure. You can find this by logging into the Azure portal and navigating to "SQL databases" (or "SQL data warehouses") -> "Select your database" -> "Overview" -> "Server name."
    • User: The name of the user authenticating to Azure.
    • Password: The password associated with the authenticating user.
    • Database: The name of the database, as seen in the Azure portal on the SQL databases (or SQL warehouses) page.

    Built-in Connection String Designer

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

    java -jar cdata.jdbc.sql.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/sql" auth="Container" type="javax.sql.DataSource" driverClassName="cdata.jdbc.sql.SQLDriver" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" url="jdbc:sql:User=myUser;Password=myPassword;Database=NorthWind;Server=myServer;Port=1433;" maxActive="20" maxIdle="10" maxWait="-1" />

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

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

More Tomcat Integration

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