Query HarperDB Data through ODBC in Node.js

Ready to get started?

Download for a free trial:

Download Now

Learn more:

HarperDB ODBC Driver

The HarperDB ODBC Driver is a powerful tool that allows you to connect with live data from HarperDB, directly from any applications that support ODBC connectivity.

Access HarperDB data like you would a relational database - read, write, and update HarperDB through a standard ODBC Driver interface.



Use node-odbc to execute SQL queries against HarperDB 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 HarperDB, you can access live HarperDB 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 HarperDB data.

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

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

Set the Server, User, and Password connection properties to connect to HarperDB. Set UseSSL to secure connections with TLS/SSL.

Building node-odbc

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

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

myscript.js

const odbc = require('odbc');

async function queryHarperDB() {
    const connection = await odbc.connect(`DSN=CData HarperDB Source`);
    const data = await connection.query('SELECT City, CompanyName FROM Customers');
    console.log(data);
}

queryHarperDB();

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