@keyv/redis

What is @keyv/redis?

@keyv/redis is an npm package that provides a Redis storage adapter for Keyv, a simple key-value storage library. It allows you to use Redis as a backend for storing key-value pairs, making it easy to integrate Redis into your Node.js applications.

What are @keyv/redis's main functionalities?

Basic Key-Value Storage

This feature allows you to store and retrieve basic key-value pairs using Redis as the backend. The code sample demonstrates how to set and get a value from the Redis store.

const Keyv = require('keyv');
const keyv = new Keyv('redis://user:pass@localhost:6379');

(async () => {
  await keyv.set('foo', 'bar');
  const value = await keyv.get('foo');
  console.log(value); // 'bar'
})();

Expiration of Keys

This feature allows you to set an expiration time for keys. The code sample demonstrates how to set a key with an expiration time and shows that the key is no longer available after the specified time.

const Keyv = require('keyv');
const keyv = new Keyv('redis://user:pass@localhost:6379');

(async () => {
  await keyv.set('foo', 'bar', 1000); // Expires in 1 second
  setTimeout(async () => {
    const value = await keyv.get('foo');
    console.log(value); // undefined
  }, 1500);
})();

Namespace Support

This feature allows you to use namespaces to avoid key collisions. The code sample demonstrates how to set and get a value within a specific namespace.

const Keyv = require('keyv');
const keyv = new Keyv({ uri: 'redis://user:pass@localhost:6379', namespace: 'myapp' });

(async () => {
  await keyv.set('foo', 'bar');
  const value = await keyv.get('foo');
  console.log(value); // 'bar'
})();

Other packages similar to @keyv/redis

ioredis

ioredis is a robust, full-featured Redis client for Node.js. It supports advanced Redis features like clustering, sentinel, and pipelining. Compared to @keyv/redis, ioredis offers more direct control over Redis commands and is suitable for more complex use cases.

redis

redis is the official Node.js client for Redis. It provides a straightforward API for interacting with Redis and supports all Redis commands. While @keyv/redis focuses on key-value storage with a simple API, redis offers more granular control and flexibility.

node-cache

node-cache is an in-memory caching module for Node.js. It provides a simple API for storing key-value pairs with optional expiration times. Unlike @keyv/redis, node-cache does not use Redis as a backend and is suitable for use cases where in-memory storage is sufficient.

README

@keyv/redis

Redis storage adapter for Keyv

Redis storage adapter for Keyv.

TTL functionality is handled directly by Redis so no timestamps are stored and expired keys are cleaned up internally.

Install

npm install --save keyv @keyv/redis

Usage

const Keyv = require('keyv');

const keyv = new Keyv('redis://user:pass@localhost:6379');
keyv.on('error', handleConnectionError);

Any valid Redis options will be passed directly through.

e.g:

const keyv = new Keyv('redis://user:pass@localhost:6379', { disable_resubscribing: true });

Or you can manually create a storage adapter instance and pass it to Keyv:

const KeyvRedis = require('@keyv/redis');
const Keyv = require('keyv');

const keyvRedis = new KeyvRedis('redis://user:pass@localhost:6379');
const keyv = new Keyv({ store: keyvRedis });

Or reuse a previous Redis instance:

const KeyvRedis = require('@keyv/redis');
const Redis = require('ioredis');
const Keyv = require('keyv');

const redis = new Redis('redis://user:pass@localhost:6379');
const keyvRedis = new KeyvRedis(redis);
const keyv = new Keyv({ store: keyvRedis });

Or reuse a previous Redis cluster:

const KeyvRedis = require('@keyv/redis');
const Redis = require('ioredis');
const Keyv = require('keyv');

const redis = new Redis.Cluster('redis://user:pass@localhost:6379');
const keyvRedis = new KeyvRedis(redis);
const keyv = new Keyv({ store: keyvRedis });

Options

useRedisSets

The useRedisSets option lets you decide whether to use Redis sets for key management. By default, this option is set to true.

When useRedisSets is enabled (true):

• A namespace for the Redis sets is created, and all created keys are added to this. This allows for group management of keys.
• When a key is deleted, it's removed not only from the main storage but also from the Redis set.
• When clearing all keys (using the clear function), all keys in the Redis set are looked up for deletion. The set itself is also deleted.

Note: In high-performance scenarios, enabling useRedisSets might lead to memory leaks. If you're running a high-performance application or service, it is recommended to set useRedisSets to false.

If you decide to set useRedisSets as false, keys will be handled individually and Redis sets won't be utilized.

However, please note that setting useRedisSets to false could lead to performance issues in production when using the clear function, as it will need to iterate over all keys to delete them.

Example

Here's how you can use the useRedisSets option:

const Keyv = require('keyv');

const keyv = new Keyv('redis://user:pass@localhost:6379', { useRedisSets: false });

License

MIT © Jared Wray