Query Smartsheet Data as a MySQL Database in Node.js

Ready to get started?

Learn more or sign up for a free trial:

CData Connect



Execute MySQL queries against Smartsheet data from Node.js.

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

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

Create a Virtual MySQL Database for Smartsheet Data

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

  1. Login to Connect Cloud and click Databases.
  2. Select "Smartsheet" from Available Data Sources.
  3. Enter the necessary authentication properties to connect to Smartsheet.

    Smartsheet uses the OAuth authentication standard. To authenticate using OAuth, you will need to register an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties.

    However, for testing purposes you can instead use the Personal Access Token you get when you create an application; set this to the OAuthAccessToken connection property.

  4. Click Test Database.
  5. Click Privileges -> Add and add the new user (or an existing user) with the appropriate permissions.

With the virtual database created, you are ready to connect to Smartsheet data from any MySQL client.

Query Smartsheet from Node.js

The following example shows how to define a connection and execute queries to Smartsheet with the MySQL module. You will need the following information:

  • Host name, or address, and port: The address of your instance of the Connect Cloud (myinstance.cdatacloud.net) and the port (3306)
  • Username and password: The username and password of a user you authorized on Connect Cloud
  • Database name: The database you configured for Smartsheet (smartsheetdb)

Connect to Smartsheet data and start executing queries with the code below:

var mysql      = require('mysql');
var fs         = require('fs');
var connection = mysql.createConnection({
  host     : 'myinstance.cdatacloud.net',
  database : 'smartsheetdb',
  port	   : '3306',
  user     : 'admin',
  password : 'password',
  ssl      : {
    ca : fs.readFileSync('C:/certs/myCA.pem')
  }
});
connection.connect();
connection.query('SELECT * FROM Sheet_Event_Plan_Budget', function(err, rows, fields) {
  if (err) throw err;
  console.log(rows);
});

connection.end();