@storehouse/redis-om

Redis OM manager for @storehouse/core.

Installation

Make sure you have @storehouse/core, redis and redis-om installed.

$ npm install @storehouse/redis-om

Usage

Basic

movies.ts

import { Schema } from 'redis-om'

export const movieSchema = new Schema('movies', {
  title: { type: 'string' },
  rate: { type: 'number' }
})

index.ts

import Storehouse from '@storehouse/core';
import { RedisOMManager } from '@storehouse/redis-om';
import { movieSchema } from './movies';

// register
Storehouse.add({
  local: {
    // type: '@storehouse/redis-om' if you called Storehouse.setManagerType(RedisOMManager)
    type: RedisOMManager, 
    config: {
      // RedisClientOptions
      options: {
        socket: {
          host: 'redis://localhost:6379'
        }
      },
      
      // Schema[]
      models: [
        movieSchema
      ]
    }
  }
});

Once the manager registered, you can access it or directly get the connection or models.

import Storehouse from '@storehouse/core';
import { RedisOMManager } from '@storehouse/redis-om';
import { RedisConnection, Repository } from 'redis-om';

// connection
const conn = await Storehouse.getConnection<RedisConnection>();
if (conn) {
  await conn.connect()
  console.log('retrieved connection to redis');
}

// manager
const localManager = Storehouse.getManager<RedisOMManager>('local');
if (localManager) {
  // Creates indexes in Redis for use by the Repository#search method.
  await localManager.createIndexes()
  // model (Repository)
  const moviesModel = localManager.getModel('movies');
  if (moviesModel) {
    console.log('nb movies', await moviesModel.search().return.count());
  }
}

// model
const Movies = Storehouse.getModel<Repository>('movies');
if(Movies) {
  console.log('nb movies', await Movies.search().return.count());
}

Helpers

There are methods to help you retrieve the connection, manager and models so you don't have to check if they are undefined. Those methods throw an error when they fail.

import Storehouse from '@storehouse/core';
import { getConnection, getManager, getModel } from '@storehouse/redis-om';

// connection
const conn = getConnection(Storehouse, 'local');
await conn.connect()
console.log('retrieved connection to redis');

// manager
const manager = getManager(Storehouse, 'local');
manager.getModel('movies');

// model
const Movies = getModel(Storehouse, 'local', 'movies');
await Movies.createIndex()
console.log('nb movies', await Movies.search().return.count());

References

• Documentation
• @storehouse/core
• Redis OM Node.js