Query Microsoft Dataverse Data as a SQL Server Database in Node.js

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

CData Connect Cloud provides a pure MySQL, cloud-to-cloud interface for Microsoft Dataverse, allowing you to easily query live Microsoft Dataverse 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 Microsoft Dataverse, leveraging server-side processing to quickly return Microsoft Dataverse data.

Configure Microsoft Dataverse Connectivity for NodeJS

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

1. Log into Connect Cloud, click Connections and click Add Connection
2. Select "Microsoft Dataverse" from the Add Connection panel
3. Enter the necessary authentication properties to connect to Microsoft Dataverse.

   You can connect without setting any connection properties for your user credentials. Below are the minimum connection properties required to connect.

   • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
   • OrganizationUrl: Set this to the organization URL you are connecting to, such as https://myorganization.crm.dynamics.com.
   • Tenant (optional): Set this if you wish to authenticate to a different tenant than your default. This is required to work with an organization not on your default Tenant.

   When you connect the Common Data Service OAuth endpoint opens in your default browser. Log in and grant permissions. The OAuth process completes automatically.

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

Add a Personal Access Token

If you are connecting from a service, application, platform, or framework that does not support OAuth authentication, you can create a Personal Access Token (PAT) to use for authentication. Best practices would dictate that you create a separate PAT for each service, to maintain granularity of access.

1. Click on your username at the top right of the Connect Cloud app and click User Profile.
2. On the User Profile page, scroll down to the Personal Access Tokens section and click Create PAT.
3. Give your 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, you are ready to connect to Microsoft Dataverse data from Node.js.

Query Microsoft Dataverse from Node.js

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

• server: tds.cdata.com
• port: 14333
• user: a Connect Cloud user (e.g. user@mydomain.com)
• password: the PAT for the above user
• database: The connection you configured for Microsoft Dataverse (CDS1)

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

var sql = require('mssql')
var config = {
	server: 'tds.cdata.com',
	port: 14333, 
	user: 'user@mydomain.com', //update me
	password: 'CONNECT_USER_PAT', //update me	
	options: {
		encrypt: true,
		database: 'CDS1'
	}
}

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

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