Keyv-Memcache

Memcache storage adapter for Keyv

Install

1npm install --save keyv-memcache

or

yarn add keyv-memcache

Usage

1const Keyv = require('keyv');
2const KeyvMemcache = require('keyv-memcache');
3
4const memcache = new KeyvMemcache('user:pass@localhost:11211');
5const keyv = new Keyv({ store: memcache });
6
7//set 
8await keyv.set("foo","bar", 6000) //Expiring time is optional
9
10//get
11let obj = await keyv.get("foo");
12
13//delete
14await keyv.delete("foo");
15
16//clear
17await keyv.clear();
18

Usage with Namespaces

1const Keyv = require('keyv');
2const KeyvMemcache = require('keyv-memcache');
3
4const memcache = new KeyvMemcache('user:pass@localhost:11211');
5const keyv1 = new Keyv({ store: memcache, namespace: "namespace1" });
6const keyv2 = new Keyv({ store: memcache, namespace: "namespace2" });
7
8//set 
9await keyv1.set("foo","bar1", 6000) //Expiring time is optional
10await keyv2.set("foo","bar2", 6000) //Expiring time is optional
11
12//get
13let obj1 = await keyv1.get("foo"); //will return bar1
14let obj2 = await keyv2.get("foo"); //will return bar2
15

Works with Memcached, Memcachier, Redislabs, and Google Cloud

Using Memcached

1. Install Memcached and start an instance

1
2//set the server to the correct address and port 
3let server = "localhost:11211"
4
5const Keyv = require("keyv");
6const KeyvMemcache = require("keyv-memcache");
7
8const memcache = new KeyvMemcache();
9const keyv = new Keyv({ store: memcache});

Using Memcachier

1. Go to https://www.memcachier.com and signup
2. Create a cache and setup where.
3. In the screen take the username, password, and url and place it into your code:

1
2//best practice is to not hard code your config in code. 
3let user = ""; 
4let pass = "";
5let server = "XXX.XXX.XXX.memcachier.com:11211"
6
7const Keyv = require("keyv");
8const KeyvMemcache = require("keyv-memcache");
9
10const memcache = new KeyvMemcache(user +":"+ pass +"@"+ server);
11const keyv = new Keyv({ store: memcache});
12

Using Redislabs Memcache Protocol

1. Go to https://www.redislabs.com and signup
2. Create a database and make sure to set the Protocol to memcached
3. In the screen take the username, password, and endpoint (the server) and place it into your code:

1
2//best practice is to not hard code your config in code. 
3let user = ""; 
4let pass = "";
5let server = "XXX.XXX.XXX.XXX.cloud.redislabs.com:XXX"
6
7const Keyv = require("keyv");
8const KeyvMemcache = require("keyv-memcache");
9
10const memcache = new KeyvMemcache(user +":"+ pass +"@"+ server);
11const keyv = new Keyv({ store: memcache});
12

Using Google Cloud

1. Go to https://cloud.google.com/ and sign up.
2. Go to the memcached configuration page in the google cloud console by navigating to Memorystore > Memcached.
3. On the memcached page (Eg. https://console.cloud.google.com/memorystore/memcached/instances?project=example), Click Create Instance
4. Fill in all mandatory fields as needed. You will need to set up a private service connection.
5. To set up a private service connection, click the Set Up Connection button.
6. Once required fields are complete, click the Create button to create the instance.
7. Google provides further documentation for connecting to and managing your Memecached instance here.

1
2const Keyv = require("keyv");
3const KeyvMemcache = require("keyv-memcache");
4
5const memcache = new KeyvMemcache("insert the internal google memcached discovery endpoint");
6const keyv = new Keyv({ store: memcache});
7

License

MIT © Jared Wray