Query Smartsheet Data as a MySQL Database in Node.js

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Smartsheet ODBC Driver

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

Access Smartsheet Sheets, Contacts, Folders, Groups, Users, etc. through a standard ODBC Driver interface.



Execute MySQL queries against Smartsheet data from Node.js.

You can use the SQL Gateway from the ODBC Driver for Smartsheet to query Smartsheet data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and start querying using Node.js.

Connect to Smartsheet 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.

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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Smartsheet data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

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 machine and port where the MySQL remoting service is listening for MySQL connections.
  • Username and password: The username and password of a user you authorized on the Users tab of the SQL Gateway.
  • Database name: The DSN you configured for the MySQL remoting service.

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

var mysql      = require('mysql');
var connection = mysql.createConnection({
  host     : 'localhost',
  database : 'CData Smartsheet Sys',
  port	   : '3306',
  user     : 'mysql_user',
  password : 'test'
});
connection.connect();
connection.query('SELECT * FROM Sheet_Event_Plan_Budget', function(err, rows, fields) {
  if (err) throw err;
  console.log(rows);
});

connection.end();