Ready to get started?

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

 Download Now

Learn more:

Google Cloud Spanner Icon Google Spanner JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Google Cloud Spanner databases.

Configure the CData JDBC Driver for Google Spanner in a Connection Pool in Tomcat



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

Connect to Google Spanner 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.

    Google Spanner uses the OAuth authentication standard. To authenticate using OAuth, you can use the embedded credentials or register an app with Google.

    See the Getting Started guide in the CData driver documentation for more information.

    Built-in Connection String Designer

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

    java -jar cdata.jdbc.googlespanner.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/googlespanner" auth="Container" type="javax.sql.DataSource" driverClassName="cdata.jdbc.googlespanner.GoogleSpannerDriver" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" url="jdbc:googlespanner:ProjectId='project1';InstanceId='instance1';Database='db1';InitiateOAuth=GETANDREFRESH" maxActive="20" maxIdle="10" maxWait="-1" />

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

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

More Tomcat Integration

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