Learn more
 

Ready to get started?

Connect to live data from Drift with the API Driver

Connect to Drift

In this article

Related articles

Connect to Drift Data in JRuby


Create a simple JRuby app with access to live Drift data.

JRuby is a high-performance, stable, fully threaded Java implementation of the Ruby programming language. The CData JDBC Driver for Drift makes it easy to integrate connectivity to live Drift data in JRuby. This article shows how to create a simple JRuby app that connects to Drift data, executes a query, and displays the results.

Configure a JDBC Connection to Drift Data

Before creating the app, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for Drift\lib).

JRuby natively supports JDBC, so you can easily connect to Drift and execute SQL queries. Initialize the JDBC connection with the getConnection function of the java.sql.DriverManager class.

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.

Below is a typical JDBC connection string for Drift:

jdbc:api:Profile=C:\profiles\Drift.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;InitiateOAuth=GETANDREFRESH

Create a JRuby App with Connectivity to Drift Data

Create a new Ruby file (for example: APISelect.rb) and open it in a text editor. Copy the following code into your file:

require 'java' require 'rubygems' require 'C:/Program Files/CData/CData JDBC Driver for Drift 2018/lib/cdata.jdbc.api.jar' url = "jdbc:api:Profile=C:\profiles\Drift.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;InitiateOAuth=GETANDREFRESH" conn = java.sql.DriverManager.getConnection(url) stmt = conn.createStatement rs = stmt.executeQuery("SELECT Id, DisplayName FROM Contacts") while (rs.next) do puts rs.getString(1) + ' ' + rs.getString(2) end

With the file completed, you are ready to display your Drift data with JRuby. To do so, simply run your file from the command line:

jruby -S APISelect.rb

Writing SQL-92 queries to Drift allows you to quickly and easily incorporate Drift data into your own JRuby applications. Download a free trial today!