Query Salesforce CRM Analytics 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 Salesforce CRM Analytics, you can access live Salesforce CRM Analytics 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 Salesforce CRM Analytics data.

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

Connecting to Salesforce CRM Analytics 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.

Salesforce CRM Analytics uses the OAuth 2 authentication standard. Obtain the OAuthClientId and OAuthClientSecret by registering an app with Salesforce CRM Analytics.

See the Getting Started section of the Help documentation for an authentication guide.

Multi-Factor Authentication (MFA)

If the connected Salesforce org has MFA enforcement enabled, set MFACode to the time-based one-time passcode (TOTP) generated by your authenticator app (such as Salesforce Authenticator or Google Authenticator). MFACode applies alongside the standard OAuth flow.

Building node-odbc

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

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

myscript.js

const odbc = require('odbc');

async function querySalesforceCRMAnalytics() {
    const connection = await odbc.connect(`DSN=CData SalesforceCRMAnalytics Source`);
    const data = await connection.query('SELECT Name, CloseDate FROM Dataset_Opportunity');
    console.log(data);
}

querySalesforceCRMAnalytics();

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