Learn more
 

Ready to get started?

Connect to live data from Drift with the API Driver

Connect to Drift

In this article

Related articles

How to Query Drift Data in MySQL Workbench


Execute MySQL queries against live Drift data from MySQL Workbench.

You can use the SQL Gateway from the ODBC Driver for Drift to query Drift data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live Drift data in MySQL Workbench.

Connect to Drift Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Drift data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Creating a MySQL Remoting Service in SQL Gateway (Salesforce is shown)

Query Drift from MySQL Workbench

The steps below outline connecting to the virtual Drift database created in the SQL Gateway from MySQL Workbench and issuing basic queries to work with live Drift data.

Connect to Drift through the SQL Gateway

  1. In MySQL Workbench, click to add a new MySQL connection.
  2. Name the connection (CData SQL Gateway for Drift).
  3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
  4. Click Store in Vault to set and store the password.
  5. Click Test Connection to ensure the connection is configured properly and click OK.

Query Drift Data

  1. Open the connection you just created (CData SQL Gateway for Drift).
  2. Click File -> New Query Tab.
  3. Write a SQL query to retrieve Drift data, like SELECT * FROM `CData API Sys`.Contacts;

With access to live Drift data from MySQL Workbench, you can easily query and update Drift, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData API Driver for ODBC and the CData SQL Gateway.