recachegoose-ioredis
v11.0.5
Published
A Mongoose caching module that works exactly how you'd expect, fully compatible with the latest version of Mongoose and optimized with ioredis for better integration in serverless environments.
Downloads
52
Maintainers
Readme
This is a fork version of recachegoose with following differences:
- Replaced recacheman with ioredis
- Improved integration with serverless environment - AWS Amplify, AWS Lambda, Google Cloud Functions, Azure Functions, etc.
recachegoose-ioredis
Mongoose Caching That Actually Works—Now with ioredis
About
A Mongoose caching module that works exactly how you'd expect, fully compatible with the latest version of Mongoose and optimized with ioredis for better integration in serverless environments.
Important:
If you are using Mongoose 4.x or below, you have to use original cachegoose and use version <= 4.x of it.
Usage
- Use Redis
var mongoose = require('mongoose');
var cachegoose = require('recachegoose-ioredis');
cachegoose(mongoose, {
port: 6379,
host: 'localhost',
password: 'yourpassword'
});
- Set Cache
Record
.find({ some_condition: true })
.cache(30) // The number of seconds to cache the query. Defaults to 60 seconds.
.exec(function(err, records) { // You are able to use callback or promise
...
});
Record
.aggregate()
.group({ total: { $sum: '$some_field' } })
.cache(0) // Explicitly passing in 0 will cache the results indefinitely.
.exec(function(err, aggResults) {
...
});
You can also pass a custom key into the .cache()
method, which you can then use later to clear the cached content.
var userId = '1234567890';
Children
.find({ parentId: userId })
.cache(0, userId + '-children') /* Will create a redis entry */
.exec(function(err, records) { /* with the key '1234567890-children' */
...
});
ChildrenSchema.post('save', function(child) {
// Clear the parent's cache, since a new child has been added.
cachegoose.clearCache(child.parentId + '-children');
});
Insert .cache()
into the queries you want to cache, and they will be cached. Works with select
, lean
, sort
, and anything else that will modify the results of a query.
Clearing the cache
If you want to clear the cache for a specific query, you must specify the cache key yourself:
function getChildrenByParentId(parentId, cb) {
Children
.find({ parentId })
.cache(0, `${parentId}_children`)
.exec(cb);
}
function clearChildrenByParentIdCache(parentId, cb) {
cachegoose.clearCache(`${parentId}_children`, cb);
}
If you call cachegoose.clearCache(null, cb)
without passing a cache key as the first parameter, the entire cache will be cleared for all queries.
Caching populated documents
When a document is returned from the cache, cachegoose will hydrate it, which initializes it's virtuals/methods. Hydrating a populated document will discard any populated fields (see Automattic/mongoose#4727). To cache populated documents without losing child documents, you must use .lean()
, however if you do this you will not be able to use any virtuals/methods (it will be a plain object).
Test
For development mode, you have to use minimum nodejs 14
npm test