Query Browse AI Data in DataGrip

DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData API Driver for JDBC, DataGrip can work with live Browse AI data. This article shows how to establish a connection to Browse AI data in DataGrip.

Create a New Driver Definition for Browse AI

The steps below describe how to create a new Data Source in DataGrip for Browse AI.

1. In DataGrip, click File -> New > Project and name the project
2. In the Database Explorer, click the plus icon () and select Driver.
3. In the Driver tab:
   • Set Name to a user-friendly name (e.g. "CData Browse AI Driver")
   • Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.api.jar).
   • Set Class to cdata.jdbc.api.API.jar
   Additionally, in the advanced tab you can change driver properties and some other settings like VM Options, VM environment, VM home path, DBMS, etc
   • For most cases, change the DBMS type to "Unknown" in Expert options to avoid native SQL Server queries (Transact-SQL), which might result in an invalid function error
4. Click "Apply" then "OK" to save the Connection

Configure a Connection to Browse AI

1. Once the connection is saved, click the plus (), then "Data Source" then "CData Browse AI Driver" to create a new Browse AI Data Source.
2. In the new window, configure the connection to Browse AI with a JDBC URL.

   Built-in Connection String Designer

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

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

   BrowseAI API Profile Settings

   BrowseAI is a web scraping and automation platform that allows you to train robots to extract and monitor data from websites. Authentication is performed using an API key that is sent as a Bearer token in the Authorization header.

   The BrowseAI API key has the format {userId}:{apiKey}, where both parts are UUIDs separated by a colon. This full string is provided as a single value in the BrowseAI dashboard.

   To obtain your API key:

   1. Log in to your BrowseAI account at https://app.browse.ai
   2. Navigate to Settings in the dashboard
   3. Locate the API section
   4. Copy the full API key string displayed (format: userId:apiKey)

   After obtaining your API key, set the following connection properties:

   • AuthScheme: Set this to APIKey.

   Set the following in the ProfileSettings connection property:

   • APIKey: Set this to your BrowseAI API key (format: userId:apiKey).
   
3. Set URL to the connection string, e.g.,

   jdbc:api:Profile=C:\profiles\BrowseAI.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_user_id:your_api_key';

4. Click "Apply" and "OK" to save the connection string

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against Browse AI

To browse through the Browse AI entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

To execute queries, right click on any table and select "New" -> "Query Console."

In the Console, write the SQL query you wish to execute. For example:

SELECT Id, Status FROM RobotTasks WHERE RobotId = 'your-robot-id'

Download a free, 30-day trial of the CData API Driver for JDBC and start working with your live Browse AI data in DataGrip. Reach out to our Support Team if you have any questions.