Query Redis Data as a MySQL Database in Node.js

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Redis ODBC Driver

The Redis ODBC Driver is a powerful tool that allows you to connect with Redis high-performance data stores, directly from any applications that support ODBC connectivity.

Read, write, and update Redis data through a standard ODBC Driver interface.



Execute MySQL queries against Redis data from Node.js.

You can use the SQL Gateway from the ODBC Driver for Redis to query Redis 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 Redis 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 a Redis instance:

  • Server: Set this to the name or address of the server your Redis instance is running on. You can specify the port in Port.
  • Password: Set this to the password used to authenticate with a password-protected Redis instance , using the Redis AUTH command.

Set UseSSL to negotiate SSL/TLS encryption when you connect.

Configure the SQL Gateway

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

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

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

connection.end();