Query Simplesat Data as a MySQL Database in Node.js

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Execute MySQL queries against Simplesat data from Node.js.

You can use the SQL Gateway from the ODBC Driver for Simplesat to query Simplesat 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 Simplesat 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.

Using API Key Authentication

Simplesat uses API Key authentication. To obtain your API key, log in to your Simplesat account and navigate to Workspace Settings > API. Copy the API key value for use in the connection string.

After setting the following connection properties, you are ready to connect:

  • AuthScheme: Set this to APIKey.
  • APIKey: Set this to your Simplesat API key obtained from workspace settings.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Simplesat 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.

Creating a MySQL Remoting Service in SQL Gateway (Salesforce is shown)

Query Simplesat from Node.js

The following example shows how to define a connection and execute queries to Simplesat 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 Simplesat data and start executing queries with the code below:

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

connection.end();

Ready to get started?

Connect to live data from Simplesat with the API Driver

Connect to Simplesat