How to connect to Drift Data in DBVisualizer



Integrate Drift data with visual data analysis tools and data connection wizards in DBVisualizer

The CData API Driver for JDBC implements JDBC standards to provide connectivity to Drift data in applications ranging from business intelligence tools to IDEs. This article shows how to establish a connection to Drift data in DBVisualizer and use the table editor to load Drift data.

Create a New Driver Definition for Drift Data

Follow the steps below to use the Driver Manager to provide connectivity to Drift data from DBVisualizer tools.

  1. In DBVisualizer, click Tools -> Driver Manager.
  2. Click the plus sign "" to create a new driver.
  3. Select "Custom" as the template.
  4. On the Driver Settings tab:
    • Set Name to a user-friendly name (e.g. "CData Drift Driver")
    • Set URL Format to jdbc:api:
    • In Driver artifacts and jar files (jars are loaded in order from top):
      1. Click the plus sign "" -> "Add Files"
      2. Navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\)
      3. Select the JAR file (cdata.jdbc.API.jar) and click "Open"
  5. The Driver Class should populate automatically. If not, select class (cdata.jdbc.api.APIDriver).

Define the Connection to the JDBC Data Source

Close the "Driver Manager" and follow the steps below to save connection properties in the JDBC URL.

  1. In the "Databases" tab, click the plus sign "" and select the driver you just created.
  2. In the "Connection" section, set the following options:

    • Database Type: If you selected the wizard option, the database type is automatically detected. If you selected the "No Wizard" option, select the Generic or Auto Detect option in the Database Type menu.
    • Driver Type: Select the driver you just created.
    • Database URL: Enter the full JDBC URL. The syntax of the JDBC URL is jdbc:api: followed by the connection properties in a semicolon-separated list of name-value pairs.

      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.

      When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

      A typical connection string is below:

      jdbc:api:Profile=C:\profiles\Drift.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;InitiateOAuth=GETANDREFRESH
    • NOTE: Since Drift does not require a User or Password to authenticate, you may use whatever values you wish for Database Userid and Database Password.
  3. On the Connection tab, click Connect.

To browse through tables exposed by the Drift JDBC Driver, right-click a table and click "Open in New Tab."

To execute SQL queries, use the SQL Commander tool: Click SQL Commander -> New SQL Commander. Select the Database Connection, Database, and Schema from the available menus.

See the "Supported SQL" chapter in the help documentation for more information on the supported SQL. See the "Data Model" chapter for table-specific information.

More Information & Free Trial

Download a free, 30-day trial of the CData API Driver for JDBC and start working with your live Drift data in DbVisualizer. Join the CData Community or reach out to our Support Team if you have any questions.

Ready to get started?

Connect to live data from Drift with the API Driver

Connect to Drift