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

Connect to Vercel 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.

   Using API Key Authentication

   Vercel uses Bearer token authentication. You can use either a personal access token or an OAuth access token as the API key.

   To obtain a personal access token:

   1. Log into your Vercel account at https://vercel.com/
   2. Navigate to Account Settings > Tokens.
   3. Click Create Token, enter a name and expiration, and click Create.
   4. Copy the generated token (it will only be shown once).

   After obtaining your token, set the following connection properties:

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your Vercel personal access token or OAuth access token.

   Example Connection String

   Profile=C:\profiles\Vercel.apip;AuthScheme=APIKey;APIKey=your_access_token;
   

   Working with Teams

   Many Vercel resources are scoped to a team. To scope all requests to a specific team, set the TeamId connection property to your team's ID. You can find your team ID by querying the Teams table or from the Vercel dashboard. Alternatively, you can specify TeamId in your SQL queries using the WHERE clause where supported.

   Connecting to Vercel

   Once the authentication is configured, you can connect to Vercel and query data from any of the available tables such as Projects, Deployments, Teams, and Domains.

   Built-in Connection String Designer

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

   java -jar cdata.jdbc.api.jar
   

   Fill in the connection properties and copy the connection string to the clipboard.

   👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
   

   You can see the JDBC URL specified in the resource definition below.

   <Resource name="jdbc/api" auth="Container" type="javax.sql.DataSource" driverClassName="cdata.jdbc.api.APIDriver" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" url="jdbc:api:Profile=C:\profiles\Vercel.apip;AuthScheme=APIKey;APIKey=your_access_token;" maxActive="20" maxIdle="10" maxWait="-1" />
   

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

3. Add a reference to the resource to the web.xml for the application.

    Vercel data JSP
    jdbc/API
    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/API");
   Connection conn = ds.getConnection();
    

More Tomcat Integration

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