Query Browse AI Data through ODBC in Node.js

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use node-odbc to execute SQL queries against Browse AI data from Node.js.

Node.js is a JavaScript runtime environment that allows you to run JavaScript code outside of a browser. With the CData API Driver for ODBC, you can access live Browse AI data from Node.js apps and scripts. In this article, we walk through installing node-odbc and the required tools to create a simple Node.js app with access to live Browse AI data.

With built-in optimized data processing, the CData ODBC Driver offers unmatched performance for interacting with live Browse AI data in Node.js. When you issue complex SQL queries from Node.js to Browse AI, the driver pushes supported SQL operations, like filters and aggregations, directly to Browse AI and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Connecting to Browse AI 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 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).

Building node-odbc

In order to connect to Browse AI through the CData ODBC Driver, you need to build node-odbc manually (after installing the required tools).

Installing the Required Tools

The following commands install the tools required to build node-odbc (note the -g parameter, which installs the tools globally).

npm i -g windows-build-tools
npm i -g node-gyp

Building node-odbc

After installing the required tools, create a directory for the Node.js app and install odbc (which builds the binary for us to use in our Node.js script).

mkdir nodeodbc
cd nodeodbc
npm i -g node

Querying Browse AI from Node.js

With the ODBC Driver installed, a DSN Configured, and node-odbc built, we are ready to query live Browse AI data from a Node.js app. The sample code below connects to a specific DSN and queries the RobotTasks table.

myscript.js

const odbc = require('odbc');

async function queryAPI() {
    const connection = await odbc.connect(`DSN=CData API Source`);
    const data = await connection.query('SELECT Id, Status FROM RobotTasks');
    console.log(data);
}

queryAPI();

Once you write the app, use node to execute the script:

node myscript.js
Sample program results (Salesforce is shown).

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

Ready to get started?

Connect to live data from Browse AI with the API Driver

Connect to Browse AI