Ready to get started?

Learn more about the CData ODBC Driver for HPCC or download a free trial:

Download Now

Query HPCC Systems Data through ODBC in Node.js

Use node-odbc to execute SQL queries against HPCC Systems 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 ODBC Driver for HPCC Systems, you can access live HPCC Systems 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 HPCC Systems data.

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

Connecting to HPCC Systems 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.

To connect, set the following connection properties: Set URL to the machine name or IP address of the server and the port the server is running on, for example, https://server:port. The User and Password are required to authenticate to the HPCC Systems cluster specified in the URL. Note that LDAP authentication is not currently supported by our ODBC driver.

Set Version to the WsSQL Web server version. Note that if you have not already done so, you will need to install the WsSQL service on the HPCC Systems server. The WsSQL Web service is used to interact with the underlying HPCC Systems platform.

Set Cluster to the target cluster.

Building node-odbc

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

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

myscript.js

const odbc = require('odbc');

async function queryHPCC() {
    const connection = await odbc.connect(`DSN=CData HPCC Source`);
    const data = await connection.query('SELECT CustomerName, Price FROM hpcc::test::orders');
    console.log(data);
}

queryHPCC();

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 HPCC Systems and start working with your live HPCC Systems data in Node.js. Reach out to our Support Team if you have any questions.