memcached-kvs

Promise based key-value storage interface for memcached.

SYNOPSIS

Text storage with Memcached or memcached-lite module.

const Memcached = require("memcached");
const textKVS = require("memcached-kvs").textKVS;

const memcached = new Memcached("localhost:11211");
const kvs = textKVS({memcached: memcached, namespace: "ns:", expires: 300});

await kvs.set("foo", "FOO");
const text = await kvs.get("foo");
await kvs.delete("foo");

memcached.end();

Buffer storage with MemJS module.

const Memjs = require("memjs");
const bufferKVS = require("memcached-kvs").bufferKVS;

const memjs = new Memjs("localhost:11211");
const kvs = bufferKVS({memjs: memjs, namespace: "ns:", expires: 300});

await kvs.set("bar", Buffer.from("BAR"));
const buffer = await kvs.get("BAR");
await kvs.delete("bar");

memjs.close();

See TypeScript declaration memcached-kvs.d.ts for more detail.

BENCHMARK

memcached-kvs does not include a brand new Memcached protocol client with itself. It provides Promise interface for other existing Memcached client modules as above.

|Interface|Backend|string 1KB|string 100KB|Buffer 1KB|Buffer 100KB| |---|---|---|---|---|---| | memcached-kvs | Memcached |7,595ms|22,361ms|7,700ms|22,340ms| | memcached-kvs | memcached-lite |7,460ms|21,408ms|7,515ms|21,123ms| | memcached-kvs | MemJS |7,486ms|21,057ms|7,373ms|21,105ms| | KeyV | Keyv-Memcache |7,556ms|21,720ms|7,898ms|27,382ms|

Above shows milliseconds to perform 10,000 operations of 10% set(), 80% get() and 10% delete() methods toward a memcached server running in localhost.

git clone https://github.com/kawanet/memcached-kvs.git
cd memcached-kvs
npm install
./node_modules/.bin/tsc -p .
docker run -d -p 11211:11211 --name memcached memcached
MEMCACHE_SERVERS=localhost:11211 REPEAT=1000 test/99.benchmark.js

SEE ALSO

• https://github.com/kawanet/memcached-kvs
• https://www.npmjs.com/package/memcached-kvs
• https://www.npmjs.com/package/key-value-compress

MIT LICENSE

Copyright (c) 2021 Yusuke Kawasaki

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.