How to connect PolyBase to PingOne

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 ODBC Driver for PingOne, you get access to your PingOne data directly alongside your SQL Server data. This article describes creating an external data source and external tables to grant access to live PingOne 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 PingOne data using PolyBase due to optimized data processing built into the driver. When you issue complex SQL queries from SQL Server to PingOne, the driver pushes down supported SQL operations, like filters and aggregations, directly to PingOne 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 PingOne data, using a single query to pull data from distributed sources.

Connect to PingOne

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 PingOne Sys is created automatically).

To connect to PingOne, configure these properties:

• Region: The region where the data for your PingOne organization is being hosted.
• AuthScheme: The type of authentication to use when connecting to PingOne.
• Either WorkerAppEnvironmentId (required when using the default PingOne domain) or AuthorizationServerURL, configured as described below.

Configuring WorkerAppEnvironmentId

WorkerAppEnvironmentId is the ID of the PingOne environment in which your Worker application resides. This parameter is used only when the environment is using the default PingOne domain (auth.pingone). It is configured after you have created the custom OAuth application you will use to authenticate to PingOne, as described in Creating a Custom OAuth Application in the Help documentation.

First, find the value for this property:

1. From the home page of your PingOne organization, move to the navigation sidebar and click Environments.
2. Find the environment in which you have created your custom OAuth/Worker application (usually Administrators), and click Manage Environment. The environment's home page displays.
3. In the environment's home page navigation sidebar, click Applications.
4. Find your OAuth or Worker application details in the list.
5. Copy the value in the Environment ID field. It should look similar to:
   WorkerAppEnvironmentId='11e96fc7-aa4d-4a60-8196-9acf91424eca'

Now set WorkerAppEnvironmentId to the value of the Environment ID field.

Configuring AuthorizationServerURL

AuthorizationServerURL is the base URL of the PingOne authorization server for the environment where your application is located. This property is only used when you have set up a custom domain for the environment, as described in the PingOne platform API documentation. See Custom Domains.

Authenticating to PingOne with OAuth

PingOne supports both OAuth and OAuthClient authentication. In addition to performing the configuration steps described above, there are two more steps to complete to support OAuth or OAuthCliet authentication:

• Create and configure a custom OAuth application, as described in Creating a Custom OAuth Application in the Help documentation.
• To ensure that the driver can access the entities in Data Model, confirm that you have configured the correct roles for the admin user/worker application you will be using, as described in Administrator Roles in the Help documentation.
• Set the appropriate properties for the authscheme and authflow of your choice, as described in the following subsections.

OAuth (Authorization Code grant)

Set AuthScheme to OAuth.

Desktop Applications

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

• InitiateOAuth: GETANDREFRESH. To avoid the need to repeat the OAuth exchange and manually setting the OAuthAccessToken each time you connect, use InitiateOAuth.
• OAuthClientId: The Client ID you obtained when you created your custom OAuth application.
• OAuthClientSecret: The Client Secret you obtained when you created your custom OAuth application.
• CallbackURL: The redirect URI you defined when you registered your custom OAuth application. For example: https://localhost:3333

When you connect, the driver opens PingOne's OAuth endpoint in your default browser. Log in and grant permissions to the application. The driver then completes the OAuth process:

1. The driver obtains an access token from PingOne and uses it to request data.
2. The OAuth values are saved in the location specified in OAuthSettingsLocation, to be persisted across connections.

The driver refreshes the access token automatically when it expires.

For other OAuth methods, including Web Applications, Headless Machines, or Client Credentials Grant, refer to the Help documentation.

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

Create an External Data Source for PingOne 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 PingOne data.

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

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

Create an External Data Source for PingOne

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

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

For PingOne, 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_pingone_source
WITH ( 
  LOCATION = 'odbc://SERVER_URL',
  CONNECTION_OPTIONS = 'DSN=CData PingOne Sys',
  -- PUSHDOWN = ON | OFF,
  CREDENTIAL = pingone_creds
);

Create External Tables for PingOne

After creating the external data source, use CREATE EXTERNAL TABLE statements to link to PingOne data from your SQL Server instance. The table column definitions must match those exposed by the CData ODBC Driver for PingOne. 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 PingOne [CData].[Administrators].Users would look similar to the following:

CREATE EXTERNAL TABLE [CData].[Administrators].Users(
  Id [nvarchar](255) NULL,
  Username [nvarchar](255) NULL,
  ...
) WITH ( 
  LOCATION='[CData].[Administrators].Users',
  DATA_SOURCE=cdata_pingone_source
);

Having created external tables for PingOne 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 PingOne, freeing up local resources and computing power. Download a free, 30-day trial of the ODBC Driver for PingOne and start working with live PingOne data alongside your SQL Server data today.