Ready to get started?

Download a free trial of the SendGrid Driver to get started:

 Download Now

Learn more:

SendGrid Icon SendGrid JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with SendGrid account data including Lists, Recipients, Schedules, Segments, and more!

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



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

Connect to SendGrid 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 make use of all the available features, provide the User and Password connection properties.

    To connect with limited features, you can set the APIKey connection property instead. See the "Getting Started" chapter of the help documentation for a guide to obtaining the API key.

    Built-in Connection String Designer

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

    java -jar cdata.jdbc.sendgrid.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/sendgrid" auth="Container" type="javax.sql.DataSource" driverClassName="cdata.jdbc.sendgrid.SendGridDriver" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" url="jdbc:sendgrid:User=admin;Password=abc123;" maxActive="20" maxIdle="10" maxWait="-1" />

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

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

More Tomcat Integration

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