Query Greenhouse Data through ODBC in Node.js

Node.js is a JavaScript runtime environment that allows you to run JavaScript code outside of a browser. With the CData ODBC Driver for Greenhouse, you can access live Greenhouse 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 Greenhouse data.

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

Connecting to Greenhouse 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.

You need an API key to connect to Greenhouse. To create an API key, follow the steps below:

1. Click the Configure icon in the navigation bar and locate Dev Center on the left.
2. Select API Credential Management.
3. Click Create New API Key.
• Set "API Type" to Harvest.
• Set "Partner" to custom.
• Optionally, provide a description.
4. Proceed to Manage permissions and select the appropriate permissions based on the resources you want to access through the driver.
5. Copy the created key and set APIKey to that value.

Building node-odbc

In order to connect to Greenhouse 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 Greenhouse from Node.js

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

myscript.js

const odbc = require('odbc');

async function queryGreenhouse() {
    const connection = await odbc.connect(`DSN=CData Greenhouse Source`);
    const data = await connection.query('SELECT Id, CandidateId FROM Applications');
    console.log(data);
}

queryGreenhouse();

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

node myscript.js

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