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

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

Connecting to SharePoint 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 URL property to the base SharePoint site or to a sub-site. This allows you to query any lists and other SharePoint entities defined for the site or sub-site.

The User and Password properties, under the Authentication section, must be set to valid SharePoint user credentials when using SharePoint On-Premise.

If you are connecting to SharePoint Online, set the SharePointEdition to SHAREPOINTONLINE along with the User and Password connection string properties. For more details on connecting to SharePoint Online, see the "Getting Started" chapter of the help documentation

Building node-odbc

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

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

myscript.js

const odbc = require('odbc');

async function querySharePoint() {
    const connection = await odbc.connect(`DSN=CData SharePoint Source`);
    const data = await connection.query('SELECT Name, Revenue FROM MyCustomList');
    console.log(data);
}

querySharePoint();

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