Query CleverPush 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 API Driver for ODBC, you can access live CleverPush 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 CleverPush data.

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

Connecting to CleverPush 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 Cleverpush Profile on disk (e.g. C:\profiles\Cleverpush.apip). Next, set the ProfileSettings connection property to the connection string for Cleverpush (see below).

Cleverpush API Profile Settings

CleverPush uses private API keys to authenticate requests. Your API key is passed as the Authorization request header value on every API call.

You can find your private API key in the CleverPush dashboard under Settings > API. Use the private key (not the public key) for server-side access.

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your CleverPush private API key.

Optional Connection Properties

• ChannelId: Set this to your default CleverPush channel identifier. Most tables require a channel filter. Setting this property allows queries without specifying ChannelId in every WHERE clause.

Building node-odbc

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

With the ODBC Driver installed, a DSN Configured, and node-odbc built, we are ready to query live CleverPush data from a Node.js app. The sample code below connects to a specific DSN and queries the Segments 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, Name FROM Segments');
    console.log(data);
}

queryAPI();

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

node myscript.js

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