Query WooCommerce Data through ODBC in 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 WooCommerce, you can access live WooCommerce 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 WooCommerce data.

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

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

WooCommerce supports the following authentication methods: one-legged OAuth1.0 Authentication and standard OAuth2.0 Authentication.

Connecting using one-legged OAuth 1.0 Authentication

Specify the following properties (NOTE: the below credentials are generated from WooCommerce settings page and should not be confused with the credentials generated by using WordPress OAuth2.0 plugin):

• ConsumerKey
• ConsumerSecret

Connecting using WordPress OAuth 2.0 Authentication

After having configured the plugin, you may connect to WooCommerce by providing the following connection properties:

• OAuthClientId
• OAuthClientSecret
• CallbackURL
• InitiateOAuth - Set this to either GETANDREFRESH or REFRESH

In either case, you will need to set the Url property to the URL of the WooCommerce instance.

Building node-odbc

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

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

myscript.js

const odbc = require('odbc');

async function queryWooCommerce() {
    const connection = await odbc.connect(`DSN=CData WooCommerce Source`);
    const data = await connection.query('SELECT ParentId, Total FROM Orders');
    console.log(data);
}

queryWooCommerce();

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