Query Highrise Data as a MySQL Database in Node.js

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Highrise ODBC Driver

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

Access Highrise data like you would a database - read, write, and update Accounts, Deals, Emails, People, Tasks, etc. through a standard ODBC Driver interface.



Execute MySQL queries against Highrise data from Node.js.

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

Highrise uses the OAuth authentication standard. To authenticate to Highrise, you will need to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL by registering an app with Highrise. You will also need to set the AccountId to connect to data.

See the "Getting Started" section in the help documentation for a guide to using OAuth.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Highrise 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 Highrise from Node.js

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

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

connection.end();