This module is a plugin for the Seneca framework. It provides a set of common caching actions (get, set, etc), backed by memcached. It also exposes all the memcached specific actions (append, prepend, etc).
By moving cache operations into Seneca, you can change your cache implementation or business rules at a later point. For example, you might decide to send certain kinds of keys to a different cache mechanism, such as redis.
If you're using this module, feel free to contact @rjrodger or @darsee on twitter if you have any questions! :)
This code snippet sets a value and then retrieves it. You'll need to have memcached running for this to work:
$ memcached -vvvar seneca = require('seneca')();
seneca.use('memcached-cache');
seneca.ready(function(err) {
seneca.act({role: 'cache', cmd: 'set', key: 'k1', val: 'v1'}, function(err) {
seneca.act({role: 'cache', cmd: 'get', key: 'k1'}, function(err, out) {
console.log('value = ' + out)
});
});
});- `` : object " "
Set plugin options when loading with:
seneca.use('memcached-cache', { name: value, ... })
Note: foo.bar in the list above means
{ foo: { bar: ... } }
- cmd:add,plugin:memcached-cache
- cmd:append,plugin:memcached-cache
- cmd:cas,plugin:memcached-cache
- cmd:decr,plugin:memcached-cache
- cmd:delete,plugin:memcached-cache
- cmd:flush,plugin:memcached-cache
- cmd:get,plugin:memcached-cache
- cmd:gets,plugin:memcached-cache
- cmd:incr,plugin:memcached-cache
- cmd:prepend,plugin:memcached-cache
- cmd:replace,plugin:memcached-cache
- cmd:set,plugin:memcached-cache
- cmd:stats,plugin:memcached-cache
- init:memcached-cache
- role:cache,cmd:add
- role:cache,cmd:clear
- role:cache,cmd:decr
- role:cache,cmd:delete
- role:cache,cmd:get
- role:cache,cmd:incr
- role:cache,cmd:set
- role:cache,get:native
No description provided.
No description provided.
No description provided.
No description provided.
No description provided.
No description provided.
No description provided.
No description provided.
No description provided.
No description provided.
No description provided.
No description provided.
No description provided.
No description provided.
No description provided.
No description provided.
No description provided.
No description provided.
No description provided.
No description provided.
No description provided.
No description provided.
npm install seneca
npm install seneca-memcached-cacheYou'll also need memcached
Seneca has a common caching API with the following actions:
role:cache, cmd:setstore a value - key and val arguments requiredrole:cache, cmd:getretreive a value - key argument is requiredrole:cache, cmd:addstore a value, only if the key does not exist - key and val arguments requiredrole:cache, cmd:deletedelete a value - key argument is required, no error if key does not existrole:cache, cmd:incrincrement a value - key and val (integer) arguments requiredrole:cache, cmd:decrdecrement a value - key and val (integer) arguments required
All caching plugins, including this one, implement this action API.
The full memcached API is also available. Use the action pattern plugin:memcached, cmd:... where cmd is one of set, get, add, delete, incr, decr, replace, append, prepend, cas, gets, stats, flush.
To access the underlying memcached instance, use the action plugin:memcached, cmd:native.
The plugin also registers with the action role:seneca, cmd:close. This closes the memcached connection when you call the seneca.close method.
You can use any of the options from the node-memcached module directly as options to this plugin:
seneca.use('memcached',{
servers:[ '127.0.0.1:11211', '127.0.0.1:11212' ],
expires: 60
})cd test
mocha cache.test.js --seneca.log.print