Import Real-Time Google Sheets Data 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 JDBC Driver for Google Spreadsheets, you can link your ColdFusion web and mobile applications to operational Google Sheets 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 Google Sheets data from within a ColdFusion markup file.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Google Sheets data. When you issue complex SQL queries to Google Sheets, the driver pushes supported SQL operations, like filters and aggregations, directly to Google Sheets 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 Google Sheets data using native data types.

Configuring the Connection to Google Sheets

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

You can connect to a spreadsheet by providing authentication to Google and then setting the Spreadsheet connection property to the name or feed link of the spreadsheet. If you want to view a list of information about the spreadsheets in your Google Drive, execute a query to the Spreadsheets view after you authenticate.

ClientLogin (username/password authentication) has been officially deprecated since April 20, 2012 and is now no longer available. Instead, use the OAuth 2.0 authentication standard. To access Google APIs on behalf on individual users, you can use the embedded credentials or you can register your own OAuth app.

OAuth also enables you to use a service account to connect on behalf of users in a Google Apps domain. To authenticate with a service account, you will need to register an application to obtain the OAuth JWT values.

See the Getting Started chapter in the help documentation to connect to Google Sheets from different types of accounts: Google accounts, Google Apps accounts, and accounts using two-step verification.

Built-in Connection String Designer

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

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 Google Sheets data and display it in a table written in the ColdFusion Markup Language, or CFML:

1. Copy the JDBC Driver for Google Sheets and lic file from "C:\Program Files\CData[product_name]\lib" to "C:\ColdFusion2021\cfusion\wwwroot\WEB-INF\lib". cdata.jdbc.googlesheets.jar cdata.jdbc.googlesheets.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:googlesheets:|connectionString|.
   • A typical connection string looks like this:

     jdbc:googlesheets:Spreadsheet=MySheet;InitiateOAuth=GETANDREFRESH

   • The Driver Class is: cdata.jdbc.googlesheets.GoogleSheetsDriver
   • 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 CDataGoogle SheetsJDBC 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="Google SheetsQuery" dataSource="CDataGoogle SheetsJDBC"> 
             SELECT * FROM Orders 
           </cfquery> 
       

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

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

   Full code, including the HTML portion is available below:

               
           <html> 
           <head><title>CData Software | Google Sheets Orders Table Demo </title></head> 
           <body> 
           <cfoutput>#ucase("Google Sheets Orders Table Demo")#</cfoutput> 
           <cfquery name="Google SheetsQuery" dataSource="CDataGoogle SheetsJDBC"> 
   
             SELECT * FROM Orders 
   
           </cfquery> 
           <cftable  
             query = "Google SheetsQuery" 
             border = "1" 
             colHeaders 
             colSpacing = "2" 
             headerLines = "2" 
             HTMLTable 
             maxRows = "500" 
             startRow = "1"> 
             <cfcol header="<b>Shipcountry</b>" align="Left" width=2 text="Shipcountry"/> 
   
             <cfcol header="<b>OrderPrice</b>" align="Left" width=15 text="OrderPrice"/> 
   
             ...
   
           </cftable> 
           </body> 
   
           </html>  
       

7. Finally, run the code locally in a browser at the default port of 8500. It produces a table populated with Google Sheets 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 Google Sheets and start building Google Sheets-connected applications with Adobe ColdFusion. Reach out to our Support Team if you have any questions.