Redis Key Slot Calculator

A high performance redis cluster key slot calculator for node redis clients e.g. node_redis, ioredis and redis-clustr.

This also handles key tags such as somekey{actualTag}.

Install

Install with NPM:

npm install cluster-key-slot --save

Usage

1const calculateSlot = require('cluster-key-slot');
2const calculateMultipleSlots = require('cluster-key-slot').generateMulti;
3
4// ...
5
6// a single slot number
7const slot = calculateSlot('test:key:{butOnlyThis}redis');
8// Buffer is also supported
9const anotherSlot = calculateSlot(Buffer.from([0x7b, 0x7d, 0x2a]));
10
11// multiple keys - multi returns a single key slot number, returns -1 if any
12// of the keys does not match the base slot number (base is defaulted to first keys slot)
13// This is useful to quickly determine a singe slot for multi keys operations.
14const slotForRedisMulti = calculateMultipleSlots([
15  'test:key:{butOnlyThis}redis',
16  'something:key45:{butOnlyThis}hello',
17  'example:key46:{butOnlyThis}foobar',
18]);

Benchmarks

OLD in these benchmarks refers to the ioredis crc calc and many of the other calculators that use Buffer.

1node -v                                                                                                                                                                                                ✔  16.38G RAM  10:29:07
2v10.15.3
3
4NEW tags x 721,445 ops/sec ±0.44% (90 runs sampled)
5OLD tags x 566,777 ops/sec ±0.97% (96 runs sampled)
6NEW without tags x 2,054,845 ops/sec ±1.77% (92 runs sampled)
7OLD without tags x 865,839 ops/sec ±0.43% (96 runs sampled)
8NEW without tags singular x 6,354,097 ops/sec ±1.25% (94 runs sampled)
9OLD without tags singular x 4,012,250 ops/sec ±0.96% (94 runs sampled)
10NEW tags (Buffer) x 552,346 ops/sec ±1.35% (92 runs sampled)