Redis et Nodejs facile avec Nohm

En faisant des recherches sur Redis et Node.js, j’étais tombé sur un projet intéressant: Nohm https://github.com/maritz/nohm qui est une sorte d’ORM pour Redis. Alors cela cache énormément le réel fonctionnement de Redis, je ne sais pas encore à quel point c’est performant ou pas, il faudra que “je mène l’enquête” mais je trouve ce framework bien sympathique. Je vous en parle donc un petit peu, en fait je vous explique ce que je suis en train de mettre en œuvre pour aller plus loin dans mes tests.

Plateforme

Pré-requis :

• node.js
• npm
• redis

Ensuite dans un répertoire, créez un fichier package.json avec le contenu suivant:

{
  "name": "play-with-redis",
  "description" : "play-with-redis",
  "version": "0.0.0",
  "dependencies": {
    "nohm": "0.9.5",
    "Faker": "0.7.2",
    "redis": "0.10"
  }
}

Pourquoi Faker? Je veux me créer une base facilement et Faker permet de générer des noms, emails, etc. … de façon aléatoire (https://github.com/marak/Faker.js/). Nous avons aussi besoin du driver redis pour node.js : https://github.com/mranney/node_redis.

Tapez la commande :

npm install

Patientez, c’est prêt.

“Remplir” la base

Créez un fichier populate.js à la racine avec le contenu suivant:

Déclarez les dépendances et variables:

var Faker = require("Faker")
  , nohm = require('nohm').Nohm
  , redis = require('redis').createClient();

Ne commencez les traitements qu’une fois la base connectée:

redis.on("ready", function (err) {

  nohm.setClient(redis);

  console.log("Connected"); // il faudrait normalement gérer les erreurs

Définir un model (c’est la partie intéressante):

  nohm.model('User', {
    properties: {
      name: {
        type: 'string',
        index: true
      },
      email: {
        type: 'string',
        index: true
      },
      country: {
        type: 'string',
        index: true
      }
    }
  });

Remarque: le fait de préciser pour une propriété index: true permettra de faire des recherches sur la propriété (champ) considéré.

Mettre des données dans la base:

  console.log("Populating Database ...")

  for(var i = 0; i <= 100000; i++) {
    // créer un user
    var user = nohm.factory('User');

    user.p({
       name: Faker.Name.findName()
     , email: Faker.Internet.email()
     , country: Faker.Address.ukCountry()
    });

    user.save(function (err) {});
    console.log(i)
  }

  console.log("the end")
    
});

Vous n’avez plus qu’à lancer, au bout de quelques instants vous disposez d’un jeu d’essai de données.

Interroger la base

Créez un fichier query.js avec le contenu suivant:

Déclarez les dépendances et variables:

var nohm = require('nohm').Nohm
  , redis = require('redis').createClient();

Comme précédement, on attend que la base soit connecté”, et ensuite on définit notre modèle:

redis.on("ready", function (err) {

  nohm.setClient(redis);

  console.log("Connected");

  var UserModel = nohm.model('User', {
    properties: {
      id: {
        type: 'string',
        unique: true
      },
      name: {
        type: 'string',
        index: true
      },
      email: {
        type: 'string',
        index: true
      },
      country: {
        type: 'string',
        index: true
      }
    }
  });

Ensuite je veux tous les users qui habitent 'England' et puis afficher le 346 ème avec ses infos:

  //England

  UserModel.find({
    country: 'England'
  }, function (err, ids) {

    console.log("English people", ids.length)

    nohm.factory('User', ids[345], function (err) {
      if (err === 'not found') {
        console.log(err);
      } else if (err) {
        console.log(err); // database or unknown error
      } else {
        console.log(this.allProperties());
      }
    });

  });

Remarque: UserModel.find() va trouver la liste des ids (clés) correspondants à la recherche, ensuite, nohm.factory('User', id_user, function (err) {}) permet de retrouver les données de l’utilisateur par son id.

J’aime beaucoup le principe, mais à l’heure qu’il est je ne sais pas si c’est utilisable tel quel en production. Il faudrait aussi voir de quelle manière c’est implémenté (anti-patterns ou pas).

Il existe aussi une version en Java, mais qui ne semble plus être maintenue depuis un moment : https://github.com/xetorthio/johm, et il semblerait que l’idée de départ viennent d’ici https://github.com/soveran/ohm (en Ruby).

Je vais me monter une stack web complète pour utiliser Nohm et je vous ferais part de mes résultats.

Vous trouverez les code d’exemples par ici https://github.com/js-experiments/play-with-redis.

Bon WE.

Demain, Angular à nouveau …