Import Real-Time Vercel Data via JDBC in ColdFusion to Build Applications

Adobe ColdFusion is a web and mobile application development platform. It uses its own scripting language, ColdFusion Markup Language (CFML), to create data-driven websites as well as generate remote services, such as REST.

When ColdFusion is paired with the CData API Driver for JDBC, you can link your ColdFusion web and mobile applications to operational Vercel data. This allows for your applications to be more robust and complete. This article details how to use the JDBC driver to create a table populated with Vercel data from within a ColdFusion markup file.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Vercel data. When you issue complex SQL queries to Vercel, the driver pushes supported SQL operations, like filters and aggregations, directly to Vercel and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Vercel data using native data types.

Configuring the Connection to Vercel

You will need a JDBC connection string to establish a connection between Coldfusion and Vercel.

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

Adding a Data Source and Creating a Table

After configuring the connection, follow the steps below to add the CData JDBC Driver to ColdFusion's lib directory, add a new data source, test the connection, create a ColdFusion markup file, and, finally, make a real-time connection with Vercel data and display it in a table written in the ColdFusion Markup Language, or CFML:

1. Copy the JDBC Driver for Vercel and lic file from "C:\Program Files\CData[product_name]\lib" to "C:\ColdFusion2021\cfusion\wwwroot\WEB-INF\lib".

               cdata.jdbc.api.jar
               cdata.jdbc.api.lic
           

   Note: If you do not copy the .lic file with the jar, you will see a licensing error that indicates you do not have a valid license installed. This is true for both the trial and full versions.

2. From the ColdFusion administrator interface, choose Data & Services.
3. Here, we can "Add New Data Source". The data source name can be any name, provided it conforms to the ColdFusion variable naming conventions. For our JDBC driver, choose "other", then click the "Add" button.
4. Next, populate the driver properties.
   • JDBC URL will need to be in the format: jdbc:api:|connectionString|.
   • A typical connection string looks like this:

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

   • The Driver Class is: cdata.jdbc.api.APIDriver
   • The Driver Name is arbitrary and simply used to recognize the data source in the ColdFusion administration console.
   
5. Now, test the connection by clicking the check mark to the left of the CDataVercelJDBC data source you just created. When the data source reports an "OK" status, it is ready for use.
6. Next, create a new ColdFusion Markup file (.cfm) and place it in the wwwroot directory ("C:\ColdFusion2021\cfusion\wwwroot") for ColdFusion.

   The following code queries the data source:

               
           <cfquery name="VercelQuery" dataSource="CDataVercelJDBC"> 
             SELECT * FROM User 
           </cfquery> 
       

   And a CFTable can be used to quickly output the table in HTML:

               
             <cftable  
             query = "VercelQuery" 
             border = "1" 
             colHeaders 
             colSpacing = "2" 
             headerLines = "2" 
             HTMLTable 
             maxRows = "500" 
             startRow = "1"> 
   
             <cfcol header="<b></b>" align="Left" width=2 text=""/> 
   
             <cfcol header="<b></b>" align="Left" width=15 text=""/> 
   
             ...
   
           </cftable> 
       

   Full code, including the HTML portion is available below:

               
           <html> 
           <head><title>CData Software | Vercel User Table Demo </title></head> 
           <body> 
           <cfoutput>#ucase("Vercel User Table Demo")#</cfoutput> 
           <cfquery name="VercelQuery" dataSource="CDataVercelJDBC"> 
   
             SELECT * FROM User 
   
           </cfquery> 
           <cftable  
             query = "VercelQuery" 
             border = "1" 
             colHeaders 
             colSpacing = "2" 
             headerLines = "2" 
             HTMLTable 
             maxRows = "500" 
             startRow = "1"> 
             <cfcol header="<b></b>" align="Left" width=2 text=""/> 
   
             <cfcol header="<b></b>" align="Left" width=15 text=""/> 
   
             ...
   
           </cftable> 
           </body> 
   
           </html>  
       

7. Finally, run the code locally in a browser at the default port of 8500. It produces a table populated with Vercel data!

As a note, the CData JDBC Drivers also support parameterized queries using the cfqueryparam element. For example:

SELECT * FROM Account WHERE name =  

Get Started Today

Download a free, 30-day trial of the CData JDBC Driver for Vercel and start building Vercel-connected applications with Adobe ColdFusion. Reach out to our Support Team if you have any questions.