Query Square 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 Square, you can access live Square 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 Square data.

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

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

Square uses the OAuth authentication standard. To authenticate using OAuth, you will need to register an app with Square to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL. See the "Getting Started" chapter of the help documentation for a guide to using OAuth.

Additionally, you must specify the LocationId. You can retrieve the Ids for your Locations by querying the Locations table. Alternatively, you can set the LocationId in the search criteria of your query.

Building node-odbc

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

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

myscript.js

const odbc = require('odbc');

async function querySquare() {
    const connection = await odbc.connect(`DSN=CData Square Source`);
    const data = await connection.query('SELECT Reason, RefundedMoneyAmount FROM Refunds');
    console.log(data);
}

querySquare();

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