How to connect PolyBase to Zoom

PolyBase for SQL Server allows you to query external data by using the same Transact-SQL syntax used to query a database table. When paired with the CData API Driver for ODBC, you get access to your Zoom data directly alongside your SQL Server data. This article describes creating an external data source and external tables to grant access to live Zoom data using T-SQL queries.

NOTE: PolyBase is only available on SQL Server 19 and above, and only for Standard SQL Server.

The CData ODBC drivers offer unmatched performance for interacting with live Zoom data using PolyBase due to optimized data processing built into the driver. When you issue complex SQL queries from SQL Server to Zoom, the driver pushes down supported SQL operations, like filters and aggregations, directly to Zoom and utilizes the embedded SQL engine to process unsupported operations (often SQL functions and JOIN operations) client-side. And with PolyBase, you can also join SQL Server data with Zoom data, using a single query to pull data from distributed sources.

Connect to Zoom

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs. To create an external data source in SQL Server using PolyBase, configure a System DSN (CData Zoom Sys is created automatically).

Start by setting the Profile connection property to the location of the Zoom Profile on disk (e.g. C:\profiles\Zoom.apip). Next, set the ProfileSettings connection property to the connection string for Zoom (see below).

Zoom API Profile Settings

To authenticate to Zoom, you can use the OAuth standard to connect to your own data or to allow other users to connect to their data.

First you will need to create an OAuth app. To do so, navigate to https://marketplace.zoom.us/develop/create and click Create under the OAuth section. Select whether or not the app will be for individual users or for the entire account, and uncheck the box to publish the app. Give the app a name and click Create. You will then be given your Client Secret and Client ID

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to OAuth.
• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
• OAuthClientID: Set this to the OAuth Client ID that is specified in your app settings.
• OAuthClientSecret: Set this to the OAuth Client Secret that is specified in your app settings.
• CallbackURL: Set this to the Redirect URI you specified in your app settings.

Click "Test Connection" to ensure that the DSN is connected to Zoom properly. Navigate to the Tables tab to review the table definitions for Zoom.

Create an External Data Source for Zoom Data

After configuring the connection, you need to create a master encryption key and a credential database for the external data source.

Creating a Master Encryption Key

Execute the following SQL command to create a new master key, 'ENCRYPTION,' to encrypt the credentials for the external data source.

CREATE MASTER KEY ENCRYPTION BY PASSWORD = 'password';

Creating a Credential Database

Execute the following SQL command to create credentials for the external data source connected to Zoom data.

NOTE: Since Zoom does not require a User or Password to authenticate, you may use whatever values you wish for IDENTITY and SECRET.

CREATE DATABASE SCOPED CREDENTIAL api_creds
WITH IDENTITY = 'username', SECRET = 'password';

Create an External Data Source for Zoom

Execute a CREATE EXTERNAL DATA SOURCE SQL command to create an external data source for Zoom with PolyBase:

• Set the LOCATION parameter , using the DSN and credentials configured earlier.

For Zoom, set SERVERNAME to the URL or address for your server (e.g. 'localhost' or '127.0.0.1' for local servers; the remote URL for remote servers). Leave PORT empty. PUSHDOWN is set to ON by default, meaning the ODBC Driver can leverage server-side processing for complex queries.

CREATE EXTERNAL DATA SOURCE cdata_api_source
WITH ( 
  LOCATION = 'odbc://SERVER_URL',
  CONNECTION_OPTIONS = 'DSN=CData Zoom Sys',
  -- PUSHDOWN = ON | OFF,
  CREDENTIAL = api_creds
);

Create External Tables for Zoom

After creating the external data source, use CREATE EXTERNAL TABLE statements to link to Zoom data from your SQL Server instance. The table column definitions must match those exposed by the CData API Driver for ODBC. You can refer to the Tables tab of the DSN Configuration Wizard to see the table definition.

Sample CREATE TABLE Statement

The statement to create an external table based on a Zoom MeetingRegistrants would look similar to the following:

CREATE EXTERNAL TABLE MeetingRegistrants(
  Id [nvarchar](255) NULL,
  JobTitle [nvarchar](255) NULL,
  ...
) WITH ( 
  LOCATION='MeetingRegistrants',
  DATA_SOURCE=cdata_api_source
);

Having created external tables for Zoom in your SQL Server instance, you are now able to query local and remote data simultaneously. Thanks to built-in query processing in the CData ODBC Driver, you know that as much query processing as possible is being pushed to Zoom, freeing up local resources and computing power. Download a free, 30-day trial of the ODBC Driver for Zoom and start working with live Zoom data alongside your SQL Server data today.