Query Magento Data through ODBC in Node.js

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Magento ODBC Driver

The Magento ODBC Driver is a powerful tool that allows you to connect with live Magento data, directly from any applications that support ODBC connectivity.

Access Magento like you would a database - read, write, and update Customers, Inventory, Products, Orders, etc. through a standard ODBC Driver interface.



Use node-odbc to execute SQL queries against Magento data from 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 Magento, you can access live Magento 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 Magento data.

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

Connecting to Magento 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.

Magento uses the OAuth 1 authentication standard. To connect to the Magento REST API, you will need to obtain values for the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties by registering an app with your Magento 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 Magento system. The URL depends on whether you are using the Magento REST API as a customer or administrator.

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

  • Administrator: To access Magento 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".

Building node-odbc

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

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

myscript.js

const odbc = require('odbc');

async function queryMagento() {
    const connection = await odbc.connect(`DSN=CData Magento Source`);
    const data = await connection.query('SELECT Name, Price FROM Products');
    console.log(data);
}

queryMagento();

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