Connect to Drift Data in RapidMiner

This article shows how you can easily integrate the CData JDBC driver for Drift into your processes in RapidMiner. This article uses the CData JDBC Driver for Drift to transfer Drift data to a process in RapidMiner.

Connect to Drift in RapidMiner as a JDBC Data Source

You can follow the procedure below to establish a JDBC connection to Drift:

1. Add a new database driver for Drift: Click Connections -> Manage Database Drivers.
2. In the resulting wizard, click the Add button and enter a name for the connection.
3. Enter the prefix for the JDBC URL: jdbc:api:
4. Enter the path to the cdata.jdbc.api.jar file, located in the lib subfolder of the installation directory.
5. Enter the driver class: cdata.jdbc.api.APIDriver
6. Create a new Drift connection: Click Connections -> Manage Database Connections.
7. Enter a name for your connection.
8. For Database System, select the Drift driver you configured previously.
9. Enter your connection string in the Host box.

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

   Drift API Profile Settings

   Drift uses OAuth-based authentication.

   You must first register an application here: https://dev.drift.com. Your app will be assigned a client ID and a client secret. Set these in your connection string via the OAuthClientId and OAuthClientSecret properties. More information on setting up an OAuth application can be found at https://devdocs.drift.com/docs/.

   After setting the following options in the ProfileSettings connection property, you are ready to connect:

   • AuthScheme: Set this to OAuth.
   • 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.
   • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Drift JDBC Driver. Either 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.

   A typical connection string is below:

   Profile=C:\profiles\Drift.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;InitiateOAuth=GETANDREFRESH
10. Enter your username and password if necessary.

You can now use your Drift connection with the various RapidMiner operators in your process. To retrieve Drift data, drag the Retrieve operator from the Operators view. With the Retrieve operator selected, you can then define which table to retrieve in the Parameters view by clicking the folder icon next to the "repository entry." In the resulting Repository Browser, you can expand your connection node to select the desired example set.

Finally, wire the output to the Retrieve process to a result, and run the process to see the Drift data.