Node.js Connection Examples
===========================

.. |checkmark| unicode:: U+2713

The `ioredis <https://github.com/luin/ioredis>`_ package is the recommended client for Redis when using Node.js.

Installation
------------

Install ioredis at the command prompt if you haven't yet:

.. code-block:: bash

   $ npm install ioredis

Connecting with SSL
-------------------

Connecting to your instance via SSL requires using a certificate authority. See documentation for `certificates and fingerprints <https://objectrocket.com/docs/redis_ssl_faq.html#certificates-fingerprints>`_ for more details.

.. code-block:: javascript

    var Redis = require('ioredis');
    var fs = require('fs');

    var ping = function(e) {
        var result = client.ping()
            .then(function(e) {
                console.log(client);
                console.log('Connected!');
            })
            .catch(function(e) {
                console.log('Error:', e);
            })
            .finally(function() {
                client.quit();
            });
    };

    try {
        var client = new Redis({
            host: '#####.publb.rackspaceclouddb.com',
            port: 1234,
            password: 'YOUR_PASSWORD',
            tls: {
                ca: fs.readFileSync('LOCAL/PATH/TO/rackspace-ca-2016.pem')
            }
        });

        ping();
    }
    catch (e) {
        console.log('Error: ', e);
    }


Connecting without SSL
-----------------------

.. code-block:: javascript

    var Redis = require('ioredis');
    var fs = require('fs');

    var ping = function(e) {
        var result = client.ping()
            .then(function(e) {
                console.log(client);
                console.log('Connected!');
            })
            .catch(function(e) {
                console.log('Error:', e);
            })
            .finally(function() {
                client.quit();
            });
    };

    try {
        var client = new Redis({
            host: '#####.publb.rackspaceclouddb.com',
            port: 1234,
            password: 'YOUR_PASSWORD'
        });

        ping();
    }
    catch (e) {
        console.log('Error: ', e);
    }

Creating, Reading, Updating and Deleting Records
-------------------------------------------------

.. code-block:: javascript

    var Redis = require('ioredis');
    var fs = require('fs');

    try {
        var client = new Redis({
            host: '#####.publb.rackspaceclouddb.com',
            port: 1234,
            password: 'YOUR_PASSWORD',
            tls: {
                ca: fs.readFileSync('LOCAL/PATH/TO/rackspace-ca-2016.pem')
            }
        });

        client.set('best_car_ever', 'Tesla Model S', function (err, result) {
            console.log('Set Record: ', result);
        });
        client.get('best_car_ever', function (err, result) {
            console.log('Get Record:', result);
        });
        client.del('best_car_ever', function (err, result) {
            console.log('Delete Record:', result);
        });
        client.get('best_car_ever', function (err, result) {
            console.log('Get Deleted Record:', result);
        });
        client.quit();
    }
    catch (e) {
        console.log('Error: ', e);
    }


Output from above:

.. code-block:: bash

   Set Record: OK
   Get Record: Tesla Model S
   Delete Record: 1
   Get Deleted Record: null

More Information
----------------

If you need additional help with ioredis, here are some useful links:

* `ioredis Official Documentation <https://github.com/luin/ioredis>`_

As always, if you have any questions, please don't hesitate to reach out to our `support team <mailto:support@objectrocket.com>`_!