Query Square Data as a SQL Server Database in Node.js

Ready to get started?

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

  Free Trial


Execute SQL Server queries against Square data from Node.js.

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

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

Connect to Square in Connect Cloud

CData Connect Cloud uses a straightforward, point-and-click interface to connect to data sources.

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

    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.

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

Query Square from Node.js

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

Connect to Square 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: 'Square1'
	}
}

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

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