Consume Snowflake OData Feeds in PowerBuilder



This article demonstrates how to consume Snowflake data as OData feeds from PowerBuilder using the API Server.

The CData API Server, when paired with the ADO.NET Provider for Snowflake (or any of 200+ other ADO.NET Providers), produces secure feeds of Snowflake data that you can consume in PowerBuilder DataWindows. The API Server supports the major Web services, including OData, Atom, JSON, HTML, CSV, TSV, and RSS. It also supports the major authentication schemes and SSL.

This article shows how to create a DataWindow that uses the CData API Server to execute reads and writes.

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 access to by clicking Settings -> Resources.

Additionally, click Settings -> Server and change the following settings for compatibility with PowerBuilder:

  • Default Format: Select XML (Atom) in the menu.
  • Default Version: Select 2.0 in the menu.

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; by default, only connections to the local machine are allowed. You can authenticate as well as encrypt connections with SSL.

Create a Profile for Snowflake

Follow the steps below to use the Database Painter tool to create a database profile for the OData API of the API Server. In the Database Painter, you can graphically manipulate data as well as execute SQL queries.

  1. Click Tools -> Database Painter.
  2. Right-click the OData node and click New Profile.
  3. In the Database Profile Setup dialog, enter the following:
    • Profile Name: Enter a user-friendly name for the profile.
    • URI: Enter the URL to the OData endpoint of the API Server. This URL will resemble the one below: http://MyServer:8032/api.rsc
    • Supply User Id and Password: Click this option to use HTTP Basic authentication. Note that the API Server also supports Windows authentication.
    • User Id: Enter the name of an user in the API Server.
    • Password: Enter the authtoken of an user in the API Server.
  4. To view and modify a table, right-click a table and then click Edit Data -> Grid.

Using Snowflake Data with PowerBuilder Controls

You can use standard PowerBuilder objects to connect to OData feeds and execute queries. The following example shows how to retrieve Snowflake data into a DataWindow.

You can add the following code to the open method:

SQLCA.DBMS = "ODT" SQLCA.DBParm = "ConnectString='URI=http://MyServer:8032/api.rsc;UID=MyAPIUser;PWD=MyAuthtoken'"; CONNECT USING SQLCA; dw_products.SetTransObject(SQLCA); dw_products.Retrieve();

Ready to get started?

Learn more or sign up for a free trial:

CData API Server