Ready to get started?

Learn more about CData Connect Cloud or sign up for free trial access:

Free Trial

Query Redis Data as a SQL Server Database in Node.js



Execute SQL Server queries against Redis data from Node.js.

You can use CData Connect Cloud to query Redis data through a SQL Server interface. Follow the procedure below to create a virtual database for Redis in Connect Cloud and start querying using Node.js.

CData Connect Cloud provides a pure MySQL, cloud-to-cloud interface for Redis, allowing you to easily query live Redis data in Node.js — without replicating the data to a natively supported database. As you query data in Node.js, CData Connect Cloud pushes all supported SQL operations (filters, JOINs, etc) directly to Redis, leveraging server-side processing to quickly return Redis data.

Configure Redis Connectivity for NodeJS

Connectivity to Redis from NodeJS is made possible through CData Connect Cloud. To work with Redis data from NodeJS, we start by creating and configuring a Redis connection.

  1. Log into Connect Cloud, click Connections and click Add Connection
  2. Select "Redis" from the Add Connection panel
  3. Enter the necessary authentication properties to connect to Redis.

    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.

  4. Click Create & Test
  5. Navigate to the Permissions tab in the Add Redis Connection page and update the User-based permissions.

Add a Personal Access Token

If you are connecting from a service, application, platform, or framework that does not support OAuth authentication, you can create a Personal Access Token (PAT) to use for authentication. Best practices would dictate that you create a separate PAT for each service, to maintain granularity of access.

  1. Click on your username at the top right of the Connect Cloud app and click User Profile.
  2. On the User Profile page, scroll down to the Personal Access Tokens section and click Create PAT.
  3. Give your PAT a name and click Create.
  4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured, you are ready to connect to Redis data from Node.js.

Query Redis from Node.js

The following example shows how to define a connection and execute queries to Redis with the SQL Server module. You will need the following information:

  • server: tds.cdata.com
  • port: 14333
  • user: a Connect Cloud user (e.g. [email protected])
  • password: the PAT for the above user
  • database: The connection you configured for Redis (Redis1)

Connect to Redis data and start executing queries with the code below:

var sql = require('mssql')
var config = {
	server: 'tds.cdata.com',
	port: 14333, 
	user: '[email protected]', //update me
	password: 'CONNECT_USER_PAT', //update me	
	options: {
		encrypt: true,
		database: 'Redis1'
	}
}

sql.connect(config, err => { 
    if(err){
        throw err ;
    }
    new sql.Request().query('SELECT * FROM Customers', (err, result) => {
        console.dir(result)
    })
        
});

sql.on('error', err => {
    console.log("SQL Error: " ,err);
})