Extend Google Sheets with Snowflake Data



Make calls to the API Server from Google Apps Script.

Interact with Snowflake data from Google Sheets through macros, custom functions, and add-ons. The CData API Server, when paired with the ADO.NET Provider for Snowflake (or any of 200+ other ADO.NET Providers), enables connectivity to Snowflake data from cloud-based and mobile applications like Google Sheets. The API Server is a lightweight Web application that produces OData services for Snowflake and any source supported by the CData ADO.NET Providers.

Google Apps Script can consume these OData services in the JSON format. This article shows how to create a simple add-on that populates a Google Spreadsheet with Products data and, as you make changes, executes updates to Snowflake data.

About Snowflake Data Integration

CData simplifies access and integration of live Snowflake data. Our customers leverage CData connectivity to:

  • Reads and write Snowflake data quickly and efficiently.
  • Dynamically obtain metadata for the specified Warehouse, Database, and Schema.
  • Authenticate in a variety of ways, including OAuth, OKTA, Azure AD, Azure Managed Service Identity, PingFederate, private key, and more.

Many CData users use CData solutions to access Snowflake from their preferred tools and applications, and replicate data from their disparate systems into Snowflake for comprehensive warehousing and analytics.

For more information on integrating Snowflake with CData solutions, refer to our blog: https://www.cdata.com/blog/snowflake-integrations.


Getting Started


Set Up the API Server

Follow the steps below to begin producing secure Snowflake OData services:

Deploy

The API Server runs on your own server. On Windows, you can deploy using the stand-alone server or IIS. On a Java servlet container, drop in the API Server WAR file. See the help documentation for more information and how-tos.

The API Server is also easy to deploy on Microsoft Azure, Amazon EC2, and Heroku.

Connect to Snowflake

After you deploy the API Server and the ADO.NET Provider for Snowflake, provide authentication values and other connection properties needed to connect to Snowflake by clicking Settings -> Connections and adding a new connection in the API Server administration console.

To connect to Snowflake:

  1. Set User and Password to your Snowflake credentials and set the AuthScheme property to PASSWORD or OKTA.
  2. Set URL to the URL of the Snowflake instance (i.e.: https://myaccount.snowflakecomputing.com).
  3. Set Warehouse to the Snowflake warehouse.
  4. (Optional) Set Account to your Snowflake account if your URL does not conform to the format above.
  5. (Optional) Set Database and Schema to restrict the tables and views exposed.

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

You can then choose the Snowflake entities you want to allow the API Server to access by clicking Settings -> Resources.

Authorize API Server Users

After determining the OData services you want to produce, authorize users by clicking Settings -> Users. The API Server uses authtoken-based authentication and supports the major authentication schemes. Access can also be restricted based on IP address: Connections from all addresses except localhost are blocked by default, so you will need to allow connections from Google's servers for this article. You can authenticate as well as encrypt connections with SSL.

Retrieve Snowflake Data

Open the Script Editor from your spreadsheet by clicking Tools -> Script Editor. In the Script Editor, add the following function to populate a spreadsheet with the results of an OData query:

function retrieve(){ var url = "https://MyUrl/api.rsc/Products?select=Id,Id,ProductName,Id"; var response = UrlFetchApp.fetch(url,{ headers: {"Authorization": "Basic " + Utilities.base64Encode("MyUser:MyAuthtoken")} }); var json = response.getContentText(); var sheet = SpreadsheetApp.getActiveSheet(); var a1 = sheet.getRange('a1'); var index=1; var products = JSON.parse(json).value; var cols = [["Id","Id","ProductName","Id"]]; sheet.getRange(1,1,1,4).setValues(cols); row=2; for(var i in products){ for (var j in products[i]) { switch (j) { case "Id": a1.offset(row,0).setValue(account[i][j]); break; case "Id": a1.offset(row,1).setValue(account[i][j]); break; case "ProductName": a1.offset(row,2).setValue(account[i][j]); break; case "Id": a1.offset(row,3).setValue(account[i][j]); break; } } row++; } }

Follow the steps below to add an installable trigger to populate the spreadsheet when opened:

  1. Click Resources -> Current Project's Triggers -> Add a New Trigger.
  2. Select retrieve in the Run menu.
  3. Select From Spreadsheet.
  4. Select On open.

After closing the dialog, you are prompted to allow access to the application.

Post Changes to Snowflake Data

Add the following function to post changes to cells back to the API Server:

function buildReq(e){ var sheet = SpreadsheetApp.getActiveSheet(); var changes = e.range; var id = sheet.getRange(changes.getRow(),1).getValue(); var col = sheet.getRange(1,changes.getColumn()).getValue(); var url = "http://MyServer/api.rsc/Products("+id+")"; var putdata = "{\"@odata.type\" : \"CDataAPI.Products\", \""+col+"\": \""+changes.getValue()+"\"}";; UrlFetchApp.fetch(url,{ method: "put", contentType: "application/json", payload: putdata, headers: {"Authorization": "Basic " + Utilities.base64Encode("MyUser:MyAuthtoken")} }); }

Follow the steps below to add the update trigger:

  1. Click Resources -> Current Project's Triggers.
  2. Select buildReq in the Run menu.
  3. Select From Spreadsheet.
  4. Select On edit.

You can test the script by clicking Publish -> Test as Add-On. Select the version, installation type, and spreadsheet to create a test configuration. You can then select and run the test configuration.

As you make changes to cells, the API Server executes updates to Snowflake data.

Ready to get started?

Learn more or sign up for a free trial:

CData API Server