Query CockroachDB Data as a MySQL Database in Node.js

Ready to get started?

Download for a free trial:

Download Now

Learn more:

CockroachDB ODBC Driver

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

Access CockroachDB data like you would a database - read, write, and update CockroachDB NewSQLDB, etc. through a standard ODBC Driver interface.



Execute MySQL queries against CockroachDB data from Node.js.

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

Set the following to connect to CockroachDB.

  • Server: The host name or IP address of the server.
  • Port: The port number of the CockroachDB server. If not specified, the default port is 26257.
  • Database: The name of the Cockroach database. If not specified, you connect to the user's default database.
  • User: The Cockroach DB user account used to authenticate.
  • Password: The password used to authenticate the user.

Configure the SQL Gateway

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

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

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

connection.end();