Ready to get started?

Learn more about CData Connect Cloud or sign up for free trial access:

Free Trial

Query Adobe Commerce Data as a SQL Server Database in Node.js



Execute SQL Server queries against Adobe Commerce data from Node.js.

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

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

Configure Adobe Commerce Connectivity for NodeJS

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

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

    Adobe Commerce uses the OAuth 1 authentication standard. To connect to the Adobe Commerce REST API, you will need to obtain values for the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties by registering an app with your Adobe Commerce system. See the "Getting Started" section in the help documentation for a guide to obtaining the OAuth values and connecting.

    You will also need to provide the URL to your Adobe Commerce system. The URL depends on whether you are using the Adobe Commerce REST API as a customer or administrator.

    • Customer: To use Adobe Commerce as a customer, make sure you have created a customer account in the Adobe Commerce homepage. To do so, click Account -> Register. You can then set the URL connection property to the endpoint of your Adobe Commerce system.

    • Administrator: To access Adobe Commerce as an administrator, set CustomAdminPath instead. This value can be obtained in the Advanced settings in the Admin menu, which can be accessed by selecting System -> Configuration -> Advanced -> Admin -> Admin Base URL.

      If the Use Custom Admin Path setting on this page is set to YES, the value is inside the Custom Admin Path text box; otherwise, set the CustomAdminPath connection property to the default value, which is "admin".

  4. Click Create & Test
  5. Navigate to the Permissions tab in the Add Adobe Commerce 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 Adobe Commerce data from Node.js.

Query Adobe Commerce from Node.js

The following example shows how to define a connection and execute queries to Adobe Commerce 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 Adobe Commerce (Adobe Commerce1)

Connect to Adobe Commerce 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: 'Adobe Commerce1'
	}
}

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);
})