Seneca plugin providing simple id-based distributed entity caching.
 |
This open source module is sponsored and supported by Voxgig. |
|---|
npm install seneca
npm install seneca-memcached-cache
npm install @seneca/entity-cacheYou'll need the seneca-memcached-cache plugin as a dependency.
You'll also need memcached
Or... you can use redis: seneca-redis-cache.
This module works by wrapping the data entity actions (role:entity, cmd:save, ... etc). You just need to register it:
var seneca = require('seneca')()
seneca.use('memcached-cache')
seneca.use('entity-cache')Then just use data entities as normal. Except things will be a lot faster.
See test/ for usage examples.
This module is a plugin for the Seneca framework. It provides a data caching mechanism for Seneca data entities. Using this module will give your Seneca app a big performance boost.
The caching mechanism goes beyond simple key-based caching using memcached. In addition, a smaller "hot" cache is maintained within the Node process. Data entities are given transient version numbers, and these are used to synchronize the hot cache with memcached.
This plays nicely with multiple memcached instances, and allows Seneca apps to scale.
(See chapter 8 of my book for details, or read How key-based cache expiration works)
If you are having difficulty, open an issue on the GitHub repo.
prefix: string "SE"maxhot: number 1111maxage: number 22222expires: number 3600hot: boolean true
Set plugin options when loading with:
seneca.use('entity-cache', { name: value, ... })
Note: foo.bar in the list above means
{ foo: { bar: ... } }
No description provided.
No description provided.
No description provided.
Here's how to set the options (the values shown are the defaults):
seneca.use('entity-cache',{
prefix: '@seneca/entity-cache',
maxhot: 1111,
expires: 3600
})Where:
- prefix: prefix string to namespace your cache (useful if your cache is used by other things)
- maxhot: the maximum number of hot items to store in the running node process memory
- expires: how long to store items (in seconds)
The Senecajs org encourages open participation. If you feel you can help in any way, be it with documentation, examples, extra testing, or new features please get in touch.
The unit tests require a running memcached and redis.
cd test
mocha *.test.js --seneca.log.printAlso
cd test
memcached -vv
mongod --dbpath=db
node n1.js --seneca.log=type:plugin
node n2.js --seneca.log=type:pluginThis plugin provides id-based distributed entity caching for the Seneca framework.
Seneca plugin providing simple id-based distributed entity caching.
