A semi-automatic caching wrapper for Sequelize NodeJS framework
npm install sequelize-redisA semi-automatic caching wrapper for Sequelize v4 NodeJS framework
``
npm install sequelize-redis
`$3
- Sequelize V4
- Redis Client (promisified with bluebird)
import SequelizeRedis from 'sequelize-redis';
import redis from 'redis';
import bluebird from 'bluebird';// Let's promisify Redis
bluebird.promisifyAll(redis.RedisClient.prototype);
bluebird.promisifyAll(redis.Multi.prototype);
// Define your redisClient
const redisClient = redis.createClient({ / Redis configuration comes here / });
// Let's start
const sequelizeRedis = new SequelizeRedis(redisClient);
2. Wrap our the Sequelize original model:
// models.User refers to model of sequelize
const User = sequelizeRedis.getModel(models.User, { ttl: 60 60 24 });
`
The second argument of is optional:| Key | Description | Default value |
|-----|-----------------------------|---------------|
| ttl | Defines cache TTL (seconds) | null |
3. Then we can start use the model wrapper:
`
const userUUID = '75292c75-4c7a-4a11-92ac-57f929f50e23';
const userCacheKey = ;
// We can use the default sequelize methods by adding suffix of "Cached"
// for example, findbyPkCached:
const [user, cacheHit] = await User.findbyPkCached(userCacheKey, userUUID);
// We can also use the non cached methods (original methods)
const user = await User.findbyPk(userUUID);
`Results of Cached methods (for ex.
) will be array with following arguments:
1. Sequelize response (same as on original method)
2. Cache hit indication (true / false)
Supported Methods:
find
Cache Invalidation
Just use regular Redis API:
redisClient.del('SampleKey');
Contribution
Feel free to contribute and submit issues.#### PR
Please make sure that your code is linted and getting build successfully
#### Thanks
Inspired by