Connect to PingOne Data as an External Source in Dremio

The CData JDBC Driver for PingOne implements JDBC Standards and allows various applications, including Dremio, to work with live PingOne data. Dremio is a data lakehouse platform designed to empower self-service, interactive analytics on the data lake. With the CData JDBC driver, you can include live PingOne data as a part of your enterprise data lake. This article describes how to connect to PingOne data from Dremio as an External Source.

The CData JDBC Driver enables high-speed access to live PingOne data in Dremio. Once you install the driver, authenticate with PingOne and gain immediate access to PingOne data within your data lake. By surfacing PingOne data using native data types and handling complex filters, aggregations, & other operations automatically, the CData JDBC Driver grants seamless access to PingOne data.

Prerequisites

This article assumes you are utilizing Docker to run Dremio. You can create a Docker container with the Dremio service using a command similar to the follow:

docker run -d --name dremio -p 9047:9047 -p 31010:31010 dremio/dremio-oss

Where dremio is the name of the container, 9047 is the container's port for the Dremio web interface and 31010 is the port that maps to the Dremio query service. dremio/dremio-oss specifies the image to use.

Build the ARP Connector

To use the CData JDBC Driver in Dremio, you need to build an Advanced Relation Pushdown (ARP) Connector. You can view the source code for the Connector on GitHub or download the ZIP file (GitHub.com) directly. Once you copy or extract the files, run the following command from the root directory of the connector (the directory containing the pom.xml file) to build the connector.

mvn clean install

NOTE: The CData ARP Connectors are build to be compiled with Java 11. Be sure to install Java 11 and use the correct version. You can update your Java version using a command similar to the following:

sudo update-alternatives --config java

Once the JAR file for the connector is built (in the target directory), you are ready to copy the ARP connector and JDBC Driver to your Dremio instance.

Installing the Connector and JDBC Driver

Install the ARP Connector to %DREMIO_HOME%/jars/ and the JDBC Driver for PingOne to %DREMIO_HOME%/jars/3rdparty. You can use commands similar to the following:

ARP Connector

docker cp PATH\TO\dremio-pingone-plugin-{DREMIO_VERSION}.jar dremio_image_name:/opt/dremio/jars/

JDBC Driver for PingOne

docker cp PATH\TO\cdata.jdbc.pingone.jar dremio_image_name:/opt/dremio/jars/3rdparty/

Connecting to PingOne

PingOne will now appear as an External Source option in Dremio. The ARP Connector built uses a JDBC URL to connect to PingOne data. The JDBC Driver has a built-in connection string designer that you can use (see below).

👁 External Sources via CData JDBC Drivers (Amazon DynamoDB & Couchbase are shown)

Built-in Connection String Designer

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

java -jar cdata.jdbc.pingone.jar

Fill in the connection properties and copy the connection string to the clipboard.

To connect to PingOne, configure these properties:

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

Configuring 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 to the value of the Environment ID field.

Configuring 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 to OAuth.

Desktop Applications

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

• : GETANDREFRESH. To avoid the need to repeat the OAuth exchange and manually setting the each time you connect, use .
• : The Client ID you obtained when you created your custom OAuth application.
• : The Client Secret you obtained when you created your custom OAuth application.
• : 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 , 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.

👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

NOTE: To use the JDBC Driver in Dremio, you will need a license (full or trial) and a Runtime Key (RTK). For more information on obtaining this license (or a trial), contact our sales team.

Add the Runtime Key (RTK) to the JDBC URL. You will end up with a JDBC URL similar to the following:

jdbc:pingone:RTK=5246...;AuthScheme=OAuth;WorkerAppEnvironmentId=eebc33a8-xxxx-4f3a-yyyy-d3e5262fd49e;Region=NA;OAuthClientId=client_id;OAuthClientSecret=client_secret;InitiateOAuth=GETANDREFRESH;

Access PingOne as an External Source

To add PingOne as an External Source, click to add a new source and select PingOne. Copy the JDBC URL and paste it into the New PingOne Source wizard.

👁 Entering the JDBC URL (Amazon DynamoDB is shown)

Save the connection and you are ready to query live PingOne data in Dremio, easily incorporating PingOne data into your data lake.

👁 Live data in Dremio (Amazon DynamoDB is shown)

More Information & Free Trial

Using the CData JDBC Driver for PingOne in Dremio, you can incorporate live PingOne data into your data lake. Check out our CData JDBC Driver for PingOne page for more information about connecting to PingOne. Download a free, 30 day trial of the CData JDBC Driver for PingOne and get started today.