Connect to Typeform Data in as an External Source in Dremio

The CData API Driver for JDBC implements JDBC Standards and allows various applications, including Dremio, to work with live Typeform 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 Typeform data as a part of your enterprise data lake. This article describes how to connect to Typeform data from Dremio as an External Source.

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

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

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 Typeform to %DREMIO_HOME%/jars/3rdparty. You can use commands similar to the following:

ARP Connector

docker cp PATH\TO\dremio-api-plugin-20.0.0.jar dremio_image_name:/opt/dremio/jars/

JDBC Driver for Typeform

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

Connecting to Typeform

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

Built-in Connection String Designer

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

java -jar cdata.jdbc.api.jar

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

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

TypeForm API Profile Settings

Authentication to TypeForm uses the OAuth standard.

To authenticate to TypeForm, you must first register and configure an OAuth application with TypeForm here: https://admin.typeform.com/account#/section/tokens. Your app will be assigned a client ID and a client secret which can be set in the connection string. More information on setting up an OAuth application can be found at https://developer.typeform.com/get-started/.

Note that there are several different use scenarios which all require different redirect URIs:

• CData Desktop Applications: CData desktop applications (Sync, API Server, ArcESB) accept OAuth tokens at /src/oauthCallback.rst. The host and port is the same as the default port used by the application. For example, if you use http://localhost:8019/ to access CData Sync then the redirect URI will be http://localhost:8019/src/oauthCallback.rst.
• CData Cloud Applications: CData cloud applications are similar to their desktop counterparts. If you access Connect Cloud at https://1.2.3.4/ then you should use the redirect https://1.2.3.4/src/oauthCallback.rst.
• Desktop Application: When using a desktop application, the URI https://localhost:33333 is recommended.
• Web Application: When developing a web application using the driver, use your own URI here such as https://my-website.com/oauth.

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 Client Id that is specified in your app settings.
• OAuthClientSecret: Set this to Client Secret that is specified in your app settings.
• CallbackURL: Set this to the Redirect URI you specified in your app settings.

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:api:RTK=5246...;Profile=C:\profiles\TypeForm.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;InitiateOAuth=GETANDREFRESH

Access Typeform as an External Source

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

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

More Information & Free Trial

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