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

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

Getting Started

---

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

There are several authentication methods available for connecting to Salesforce: OAuth, Login (or basic), and SSO. The Login method requires you to have the username, password, and security token of the user.

OAuth Authentication (default)

The default authentication mechanism (and the one preferred by Salesforce) is OAuth. To use OAuth with CData's embedded OAuth application, leave the connection properties blank. If you have configured your own custom OAuth application with Salesforce (see the Help documentation for more information), set OAuthClientId, OAuthClientSecret, and CallbackURL to the properties for you application. Set InitiateOAuth to the desired OAuth flow ("GETANDREFRESH" will have the connector manage the entire OAuth flow).

Login (or Basic) Authentication

If you do not wish do not wish to use OAuth authentication, you can use Login (or basic) authentication. Set AuthScheme to Basic, and set the User, Password, and SecurityToken properties. You can configure your security token in Salesforce.

SSO (single sign-on) Authentication

SSO (single sign-on) can be used by setting the SSOProperties, SSOLoginUrl, and SSOExchangeURL connection properties, which allow you to authenticate to an identity provider. See the "Getting Started" chapter in the Help documentation for more information.

Multi-Factor Authentication (MFA)

If your 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 to both OAuth and Login authentication flows.

Building node-odbc

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

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

myscript.js

const odbc = require('odbc');

async function querySalesforce() {
 const connection = await odbc.connect(`DSN=CData Salesforce Source`);
 const data = await connection.query('SELECT Industry, AnnualRevenue FROM Account');
 console.log(data);
}

querySalesforce();

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

node myscript.js

👁 Sample program results (Salesforce is shown).

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