Ready to get started?

Download a free trial of the Cloudant ODBC Driver to get started:

 Download Now

Learn more:

IBM Cloudant Icon Cloudant ODBC Driver

The IBM Cloudant ODBC Driver is a powerful tool that allows you to connect with live Cloudant document databases, directly from any applications that support ODBC connectivity.

Access IBM Cloudant like you would a database - read, write, and update through a standard ODBC Driver interface.

Query Cloudant Data as a MySQL Database in Node.js



Execute MySQL queries against Cloudant data from Node.js.

You can use the SQL Gateway from the ODBC Driver for Cloudant to query Cloudant 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 Cloudant 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 connection properties to connect to Cloudant:

  • User: Set this to your username.
  • Password: Set this to your password.

Configure the SQL Gateway

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

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

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

connection.end();