Query Azure Synapse Data as a SQL Server Database in Node.js

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

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

Configure Azure Synapse Connectivity for NodeJS

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

1. Log into Connect AI, click Sources, and then click Add Connection
👁 Adding a Connection

2. Select "Azure Synapse" from the Add Connection panel
👁 Selecting a data source

3. Enter the necessary authentication properties to connect to Azure Synapse.

   Connecting to Azure Synapse

   In addition to providing authentication (see below), set the following properties to connect to a Azure Synapse database:

   • Server: The server running Azure. You can find this by logging into the Azure portal and navigating to Azure Synapse Analytics -> Select your database -> Overview -> Server name.
   • Database: The name of the database, as seen in the Azure portal on the Azure Synapse Analytics page.

   Authenticating to Azure Synapse

   Connect to Azure Synapse using the following properties:

   • User: The username provided for authentication with Azure.
   • Password: The password associated with the authenticating user.
   👁 Configuring a connection (Salesforce is shown)
   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add Azure Synapse Connection page and update the User-based permissions. 👁 Updating permissions
   

Add a Personal Access Token

When connecting to Connect AI 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 AI. 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 AI 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. 👁 Creating a new PAT
   
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 Azure Synapse data from Node.js.

Query Azure Synapse from Node.js

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

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

Connect to Azure Synapse 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: 'AzureSynapse1'
	}
}

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

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