Query SharePoint Data as a SQL Server Database in Node.js

You can use CData Connect Cloud to query SharePoint data through a SQL Server interface. Follow the procedure below to create a virtual database for SharePoint in Connect Cloud and start querying using Node.js.

CData Connect Cloud provides a pure MySQL, cloud-to-cloud interface for SharePoint, allowing you to easily query live SharePoint data in Node.js — without replicating the data to a natively supported database. As you query data in Node.js, CData Connect Cloud pushes all supported SQL operations (filters, JOINs, etc) directly to SharePoint, leveraging server-side processing to quickly return SharePoint data.

Getting Started

---

Configure SharePoint Connectivity for NodeJS

Connectivity to SharePoint from NodeJS is made possible through CData Connect Cloud. To work with SharePoint data from NodeJS, we start by creating and configuring a SharePoint connection.

1. Log into Connect Cloud, click Sources, and then click Add Connection

2. Select "SharePoint" from the Add Connection panel

3. Enter the necessary authentication properties to connect to SharePoint.

   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

   
4. Click Create & Test
5. Navigate to the Permissions tab in the Add SharePoint Connection page and update the User-based permissions.

Add a Personal Access Token

When connecting to Connect Cloud through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect Cloud. It is best practice to create a separate PAT for each service to maintain granularity of access.

1. Click on the Gear icon () at the top right of the Connect Cloud app to open the settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create.
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, you are ready to connect to SharePoint data from Node.js.

Query SharePoint from Node.js

The following example shows how to define a connection and execute queries to SharePoint with the SQL Server module. You will need the following information:

• server: tds.cdata.com
• port: 14333
• user: a Connect Cloud user (e.g. [email protected])
• password: the PAT for the above user
• database: The connection you configured for SharePoint (SharePoint1)

Connect to SharePoint data and start executing queries with the code below:

var sql = require('mssql')
var config = {
	server: 'tds.cdata.com',
	port: 14333, 
	user: '[email protected]', //update me
	password: 'CONNECT_USER_PAT', //update me	
	options: {
		encrypt: true,
		database: 'SharePoint1'
	}
}

sql.connect(config, err => { 
    if(err){
        throw err ;
    }
    new sql.Request().query('SELECT * FROM MyCustomList', (err, result) => {
        console.dir(result)
    })
        
});

sql.on('error', err => {
    console.log("SQL Error: " ,err);
})