# egg-redis > Redis plugin for egg Latest version **2.6.1** (published 2025-01-19) · MIT license · 0 weekly downloads ## Install ```sh npm install egg-redis pnpm add egg-redis yarn add egg-redis bun add egg-redis ``` ## Health **Score 40/100 (D)** — status: maintenance-mode. Positive: has types; no vulnerabilities; has provenance; high quality score. Warnings: low downloads; no esm support. Negative: stale; low maintenance score. ## Facts | | | |---|---| | Version | 2.6.1 | | Published | 2025-01-19 | | First published | 2017-02-13 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Node | >=6.0.0 | | Dependencies | 3 | | Unpacked size | 12.9 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Provenance | attested (GitHub Actions) | | Author | jtyjty99999 | | Maintainers | jtyjty99999, atian25, dead_horse, fengmk2 | | Keywords | egg, eggPlugin, egg-plugin, redis, database | ## Links - npm: https://www.npmjs.com/package/egg-redis - Repository: https://github.com/eggjs/redis - Homepage: https://github.com/eggjs/redis#readme - Issues: https://github.com/eggjs/egg/issues - npm.io page: https://npm.io/package/egg-redis ## Dependencies (3) - [ioredis](https://npm.io/package/ioredis.md) ^4.9.0 - [await-first](https://npm.io/package/await-first.md) ^1.0.0 - [@types/ioredis](https://npm.io/package/@types/ioredis.md) ^4.0.10 ## Alternatives - [memory-cache](https://npm.io/package/memory-cache.md) — 795.0K weekly downloads - [@httptoolkit/proxy-agent](https://npm.io/package/@httptoolkit/proxy-agent.md) — 11.2K weekly downloads - [express-cache-controller](https://npm.io/package/express-cache-controller.md) — 5.3K weekly downloads - [http-cache-middleware](https://npm.io/package/http-cache-middleware.md) — 4.5K weekly downloads - [cache2](https://npm.io/package/cache2.md) — 1.5K weekly downloads ## Recent versions - 2.6.1 (latest) — 2025-01-19 - 2.6.0 — 2024-04-07 - 2.5.0 — 2023-06-06 - 2.4.0 — 2019-06-13 - 2.3.2 — 2019-04-24 - 2.3.1 — 2019-04-10 - 2.3.0 — 2018-12-18 - 2.2.0 — 2018-12-04 - 2.1.0 — 2018-11-28 - 2.0.1 — 2018-11-28 - 2.0.0 — 2018-02-27 - 1.0.2 — 2017-07-13 - 1.0.1 — 2017-02-21 - 1.0.0 — 2017-02-17 - 0.0.2 — 2017-02-16 - … 1 more at https://npm.io/package/egg-redis/versions ## README # egg-redis [![NPM version][npm-image]][npm-url] [![Node.js CI](https://github.com/eggjs/redis/actions/workflows/nodejs.yml/badge.svg)](https://github.com/eggjs/redis/actions/workflows/nodejs.yml) [![Test coverage][codecov-image]][codecov-url] [![Known Vulnerabilities][snyk-image]][snyk-url] [![npm download][download-image]][download-url] [![Node.js Version](https://img.shields.io/node/v/egg-redis.svg?style=flat)](https://nodejs.org/en/download/) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com) ![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/eggjs/redis) [npm-image]: https://img.shields.io/npm/v/egg-redis.svg?style=flat-square [npm-url]: https://npmjs.org/package/egg-redis [codecov-image]: https://codecov.io/gh/eggjs/redis/branch/master/graph/badge.svg [codecov-url]: https://codecov.io/gh/eggjs/redis [snyk-image]: https://snyk.io/test/npm/egg-redis/badge.svg?style=flat-square [snyk-url]: https://snyk.io/test/npm/egg-redis [download-image]: https://img.shields.io/npm/dm/egg-redis.svg?style=flat-square [download-url]: https://npmjs.org/package/egg-redis Redis client(support redis protocol) based on ioredis for egg framework ## Install ```bash npm i egg-redis --save ``` redis Plugin for egg, support egg application access to redis. This plugin based on [ioredis](https://github.com/luin/ioredis), if you want to know specific usage, you should refer to the document of [ioredis](https://github.com/luin/ioredis). ## Configuration Change `${app_root}/config/plugin.js` to enable redis plugin: ```js exports.redis = { enable: true, package: 'egg-redis', }; ``` Configure redis information in `${app_root}/config/config.default.js`: **Single Client** ```javascript config.redis = { client: { port: 6379, // Redis port host: '127.0.0.1', // Redis host password: 'auth', db: 0, }, } ``` **Multi Clients** ```javascript config.redis = { clients: { foo: { // instanceName. See below port: 6379, // Redis port host: '127.0.0.1', // Redis host password: 'auth', db: 0, }, bar: { port: 6379, host: '127.0.0.1', password: 'auth', db: 1, }, } } ``` **Sentinel** ```javascript config.redis = { client: { sentinels: [{ // Sentinel instances port: 26379, // Sentinel port host: '127.0.0.1', // Sentinel host }], name: 'mymaster', // Master name password: 'auth', db: 0 }, } ``` **No password** Redis support no authentication access, but we are highly recommend you to use redis `requirepass` in `redis.conf`. ```bash $vim /etc/redis/redis.conf requirepass xxxxxxxxxx // xxxxxxxxxx is your password ``` Because it may be cause security risk, refer: - - If you want to access redis with no password, use `password: null`. See [ioredis API Documentation](https://github.com/luin/ioredis/blob/master/API.md#new_Redis) for all available options. ### Customize `ioredis` version `egg-redis` using ioredis@4 now, if you want to use other version of ioredis, you can pass the instance by `config.redis.Redis`: ```js // config/config.default.js config.redis = { Redis: require('ioredis'), // customize ioredis version, only set when you needed client: { port: 6379, // Redis port host: '127.0.0.1', // Redis host password: 'auth', db: 0, }, } ``` **weakDependent** ```javascript config.redis = { client: { port: 6379, // Redis port host: '127.0.0.1', // Redis host password: 'auth', db: 0, weakDependent: true, // this redis instance won't block app start }, } ``` ## Usage In controller, you can use `app.redis` to get the redis instance, check [ioredis](https://github.com/luin/ioredis#basic-usage) to see how to use. ```js // app/controller/home.js module.exports = app => { return class HomeController extends app.Controller { async index() { const { ctx, app } = this; // set await app.redis.set('foo', 'bar'); // get ctx.body = await app.redis.get('foo'); } }; }; ``` ### Multi Clients If your Configure with multi clients, you can use `app.redis.get(instanceName)` to get the specific redis instance and use it like above. ```js // app/controller/home.js module.exports = app => { return class HomeController extends app.Controller { async index() { const { ctx, app } = this; // set await app.redis.get('instance1').set('foo', 'bar'); // get ctx.body = await app.redis.get('instance1').get('foo'); } }; }; ``` ### Clients Depend on Redis Cluster Before you start to use Redis Cluster, please checkout the [document](https://redis.io/topics/cluster-tutorial) first, especially confirm `cluster-enabled yes` in Redis Cluster configuration file. In controller, you also can use `app.redis` to get the redis instance based on Redis Cluster. ```js // app/config/config.default.js exports.redis = { client: { cluster: true, nodes: [{ host: '127.0.0.1', port: '6379', family: 'user', password: 'password', db: 'db', }, { host: '127.0.0.1', port: '6380', family: 'user', password: 'password', db: 'db', }] }, }; // app/controller/home.js module.exports = app => { return class HomeController extends app.Controller { async index() { const { ctx, app } = this; // set await app.redis.set('foo', 'bar'); // get ctx.body = await app.redis.get('foo'); } }; }; ``` ## Questions & Suggestions Please open an issue [here](https://github.com/eggjs/egg/issues). ## License [MIT](LICENSE) ## Contributors [![Contributors](https://contrib.rocks/image?repo=eggjs/redis)](https://github.com/eggjs/redis/graphs/contributors) Made with [contributors-img](https://contrib.rocks). --- _Source: https://npm.io/package/egg-redis · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._