4.18.0 (2020-07-25)
- supports commands in Redis 6.0.6 (c016265)
4.17.3 (2020-05-30)
- race conditions in
Redis#disconnect()can cancel reconnection unexpectedly (6fad73b), closes #1138 #1007
4.17.2 (2020-05-30)
4.17.1 (2020-05-16)
4.17.0 (2020-05-16)
4.16.3 (2020-04-21)
4.16.2 (2020-04-11)
- dismiss security alerts for dev dependencies [skip release] (758b3f2)
- handle connection after connect event was emitted (#1095) (16a0610), closes #977
4.16.1 (2020-03-28)
4.16.0 (2020-02-19)
4.15.1 (2019-12-25)
- ignore empty hosts returned by CLUSTER SLOTS (#1025) (d79a8ef)
- prevent exception when send custom command (04cad7f)
4.15.0 (2019-11-29)
- support multiple fields for hset (51b1478)
4.14.4 (2019-11-22)
4.14.3 (2019-11-07)
- update funding information (c83cb05)
4.14.2 (2019-10-23)
- security deps updates [skip ci] (a7095d7)
4.14.1 (2019-08-27)
4.14.0 (2019-07-31)
- support rediss:// URL (371bb9c)
4.13.1 (2019-07-22)
4.13.0 (2019-07-19)
4.12.2 (2019-07-16)
- cluster: prefer master when there're two same node for a slot (8fb9f97)
- cluster: remove node immediately when slots are redistributed (ecc13ad), closes #930
4.12.1 (2019-07-15)
4.12.0 (2019-07-14)
4.11.2 (2019-07-13)
4.11.1 (2019-06-26)
4.11.0 (2019-06-25)
4.10.4 (2019-06-11)
4.10.3 (2019-06-08)
4.10.2 (2019-06-08)
4.10.1 (2019-06-08)
4.10.0 (2019-05-23)
4.9.5 (2019-05-15)
4.9.4 (2019-05-13)
4.9.3 (2019-05-07)
4.9.2 (2019-05-03)
4.9.1 (2019-03-22)
4.9.0 (2019-03-18)
4.8.0 (2019-03-12)
4.7.0 (2019-03-12)
- add updateSentinels option to control new sentinel values being added to the original list (#814) (50a9db7), closes #798
4.6.3 (2019-02-03)
4.6.2 (2019-02-02)
4.6.1 (2019-01-29)
4.6.0 (2019-01-21)
4.5.1 (2019-01-13)
4.5.0 (2019-01-07)
- allow TLS when using Sentinel (ebef8f5)
4.4.0 (2019-01-04)
4.3.1 (2018-12-16)
4.3.0 (2018-12-09)
4.2.3 (2018-11-24)
4.2.2 (2018-10-20)
4.2.1 (2018-10-19)
4.2.0 (2018-10-17)
- support customize dns lookup function (#723) (b9c4793), closes antirez/redis#2410
4.1.0 (2018-10-15)
- cluster: quit() ignores errors caused by disconnected connection (#720) (fb3eb76)
- cluster: robust solution for pub/sub in cluster (#697) (13a5bc4), closes #696
- cluster: stop subscriber when disconnecting (fb27b66)
- cluster: re-select subscriber when the currenct one is failed (c091f2e)
- remove lodash deps for smaller memory footprint (80f4a45)
- cluster: make disconnecting from cluster faster (#721) (ce46d6b)
4.0.2 (2018-10-09)
- reduce package bundle size (eb68e9a)
4.0.1 (2018-10-08)
4.0.0 (2018-08-14)
This is a major release and contain breaking changes. Please read this changelog before upgrading.
- export Pipeline for inheritances enabling (#675) (ca58249)
- export ScanStream at package level (#667) (5eb4198)
- Sentinel: unreachable errors when sentinals are healthy (7bf6fea)
- resolve warning for Buffer() in Node.js 10 (6144c56)
- don't add cluster.info to the failover queue before ready (491546d)
- solves vulnerabilities dependencies (2950b79)
- Cluster: issues when setting enableOfflineQueue to false (#649) (cfe4258)
- upgrade redis-parser for better performance.
- use native Promise instead of Bluebird, and allow users to switch back. (da60b8b)
- add maxRetriesPerRequest option to limit the retries attempts per command (1babc13)
Redis#connect()will be resolved when status is ready (#648) (f0c600b)- add debug details for connection pool (9ec16b6)
- wait for ready state before resolving cluster.connect() (7517a73)
- Drop support for < node v6
- Use native Promise instead of Bluebird. This change makes all the code that rely on the features provided by Bluebird not working
anymore. For example,
redis.get('foo').timeout(500)now should be failed since the native Promise doesn't support thetimeoutmethod. You can switch back to the Bluebird implementation by settingRedis.Promise:
const Redis = require('ioredis')
Redis.Promise = require('bluebird')
const redis = new Redis()
// Use bluebird
assert.equal(redis.get().constructor, require('bluebird'))
// You can change the Promise implementation at any time:
Redis.Promise = global.Promise
assert.equal(redis.get().constructor, global.Promise)
Redis#connect()will be resolved when status is ready instead ofconnect:
const redis = new Redis({ lazyConnect: true })
redis.connect().then(() => {
assert(redis.status === 'ready')
})
Cluster#connect()will be resolved when the connection status becomereadyinstead ofconnect.- The maxRetriesPerRequest is set to 20 instead of null (same behavior as ioredis v3) by default. So when a redis server is down, pending commands won't wait forever until the connection become alive, instead, they only wait about 10s (depends on the retryStrategy option)
- The
newkeyword is required explicitly. CallingRedisas a function like Redis(/* options /)is deprecated and will not be supported in the next major version, usenew Redis(/ options */)` instead.
4.0.0-3 (2018-07-22)
- Sentinel: unreachable errors when sentinals are healthy (7bf6fea)
- resolve warning for Buffer() in Node.js 10 (6144c56)
4.0.0-2 (2018-07-07)
Upgrade redis-parser to v3. See release notes on redis-parser repo for details.
4.0.0-1 (2018-07-02)
- remove unnecessary bluebird usage (2502b1b)
4.0.0-0 (2018-07-01)
- Deprecated
Redis()in favor ofnew Redis()(8e7c6f1) - don't add cluster.info to the failover queue before ready (491546d)
- solves vulnerabilities dependencies (2950b79)
- Cluster: issues when setting enableOfflineQueue to false (#649) (cfe4258)
- use native Promise instead of Bluebird, and allow users to switch back. (da60b8b)
- add maxRetriesPerRequest option to limit the retries attempts per command (1babc13)
Redis#connect()will be resolved when status is ready (#648) (f0c600b)- add debug details for connection pool (9ec16b6)
- wait for ready state before resolving cluster.connect() (7517a73)
- Drop support for < node v6
- Use native Promise instead of Bluebird. This change makes all the code that rely on the features provided by Bluebird not working
anymore. For example,
redis.get('foo').timeout(500)now should be failed since the native Promise doesn't support thetimeoutmethod. You can switch back to the Bluebird implementation by settingRedis.Promise:
const Redis = require('ioredis')
Redis.Promise = require('bluebird')
const redis = new Redis()
// Use bluebird
assert.equal(redis.get().constructor, require('bluebird'))
// You can change the Promise implementation at any time:
Redis.Promise = global.Promise
assert.equal(redis.get().constructor, global.Promise)
Redis#connect()will be resolved when status is ready instead ofconnect:
const redis = new Redis({ lazyConnect: true })
redis.connect().then(() => {
assert(redis.status === 'ready')
})
Cluster#connect()will be resolved when the connection status becomereadyinstead ofconnect.- The maxRetriesPerRequest is set to 20 instead of null (same behavior as ioredis v3) by default. So when a redis server is down, pending commands won't wait forever until the connection become alive, instead, they only wait about 10s (depends on the retryStrategy option)
- The
newkeyword is required explicitly. CallingRedisas a function likeRedis(/* options */)is deprecated and will not be supported in the next major version, usenew Redis(/* options */)instead.
3.2.2 (2017-11-30)
3.2.1 (2017-10-04)
- Cluster: empty key name was sent to random nodes (e42f30f)
3.2.0 (2017-10-01)
3.1.4 (2017-08-13)
We mistakenly used Object.assign to replace lodash.assign in v3.1.3, which is not supported
by the old Node.js version (0.10.x). This change was a BC change and shouldn't happen without changing
the major version, so we added lodash.assign back.
3.1.3 (2017-08-13)
3.1.2 (2017-07-26)
3.1.1 (2017-05-31)
- show error name the error stack for Node.js 8 (a628aa7)
3.1.0 (2017-05-30)
3.0.0 (2017-05-18)
- pipeline: add #length to get the command count (a6060cb), closes #461
- sentinel: allow connection to IPv6-only sentinels (#463) (a389f3c)
3.0.0-2 (2017-05-03)
- restore the default connectTimeout to 10000 (dc8256e)
3.0.0-1 (2017-04-16)
- add debug logs for resolved sentinel nodes (8f3d3f7)
- report error on Sentinel connection refused (#445) (#446) (286a5bc)
- set default port of sentinels to 26379. (#441) (539fe41)
- The default port of sentinels are now 26379 instead of 6379. This shouldn't break your app in most case since few setups has the sentinel server running on 6379, but if it's your case and the port isn't set explicitly, please go to update it.
3.0.0-0 (2017-01-26)
This is a performance-focused release. We finially switch to the new version of JavaScript parser and drop the support for hiredis (Thanks to the lovely community!). Also, we switch to denque to improve the queueing performance.
Let us know if there's any issue when using this pre-release.
- Although the interface doesn't change after upgrading the js parser, there may be still some potential internal differences that may break the applications which rely on them. Also, force a major version bump emphasizes the dropping of the hiredis.
2.5.0 (2017-01-06)
- quit immediately when in reconnecting state (#410) (a6f04f2)
2.4.3 (2016-12-15)
- wait all the commands in a pipeline before sending #411 (#413) (bfa879a)
2.4.2 (2016-12-04)
- handle error when creating tls connection (904f433)
2.4.1 (2016-12-04)
- by default call setNoDelay on the stream (#406) (990a221)
2.4.0 (2016-09-24)
2.3.1 (2016-09-24)
- prevent sentinel from getting duplicated nodes (0338677)
2.3.0 (2016-08-11)
2.2.0 (2016-06-28)
- cluster: ensure node exists before being redirected via an ASK (#341) (5d9d0d3)
2.1.0 (2016-06-22)
- sentinel: update sentinels after getting master (e3f14b2)
2.0.1 (2016-06-01)
- fix transaction with dropBufferSupport:true(47a2d9a)
2.0.0 (2016-05-29)
Refer to Breaking Changes between V1 and V2 for all breaking changes.
Changes since 2.0.0-rc4:
2.0.0-rc4 (2016-05-08)
- reconnect when ready check failed(3561fab)
- remove data handler when flushing command queue(b1c761c)
- won't emit error again when password is wrong(dfdebfe)
- add dropBufferSupport option to improve the performance (#293)(1a8700c)
- add support for Node.js v6 (#295)(a87f405)
- emit authentication related errors with "error" event(9dc25b4)
- print logs for unhandled error event(097fdbc)
- Authentication related errors are emited with "error" event, instead of "authError" event
2.0.0-rc3 (2016-05-02)
- fix wrong host not causing error (25c300e), closes #287
- reconnect when getting fatal error (#292) (1cf2ac1)
- deps: upgrade redis-commands package (df08250)
2.0.0-rc2 (2016-04-10)
- CLUSTER: fix cluster not disconnected when called disconnect method (#281) (91998e3), closes [(#281](https://github.com/(/issues/281)
- sentinel: improve the error message when connection to sentinel is rejected (3ca30d8), closes #280
2.0.0-rc1 (2016-03-18)
- dependencies: upgrade all dependencies to the newest version (3fdafc8).
2.0.0-alpha3 (2016-03-13)
- auth: emit authError when the server requiring a password (c5ca754)
- cluster: add enableReadyCheck option for cluster (b63cdc7)
- cluster: redirect on TRYAGAIN error (b1a4b62)
- cluster: support update startupNodes in clusterRetryStrategy (4a46766)
- transaction: transform replies of transactions (e0b1883), closes #158
- Reply transformers is supported inside transactions.
Pipeline#execBuffer()is deprecated. UsePipeline#exec()instead.
2.0.0-alpha2 (2016-02-29)
- cluster: fix memory leaking in sendCommand method (410af51)
- cluster: add the option for a custom node selector in scaleReads (6795b1e)
2.0.0-alpha1 (2016-02-10)
- cluster: avoid command.reject being overwritten twice (d0a0017)
- cluster: fix not connecting to the unknown nodes (0dcb768)
- cluster: set retryDelayOnFailover from 2000ms to 200ms (72fd804)
- cluster: support scaling reads to slaves (98bdec2), closes #170
- redis: support readonly mode for cluster (0a4186e)
- cluster:
Cluster#masterNodesandCluster#nodesis removed. UseCluster#nodes('masters')andCluster#nodes('all')instead. - cluster:
Cluster#to()is removed. UsePromise.all(Cluster#nodes().map(function (node) {}))instead. - cluster: Option
readOnlyis removed. Check outscaleReadsoption.
1.15.1 (2016-02-19)
1.15.0 (2016-01-31)
- "MOVED" err not crashing process when slot was not assigned (6974d4d)
- remove extra typeof in .to cluster helper (a7b0bfe)
- revisit of .to(nodeGroup) command (ba12e47)
- Support returning buffers for transactions (#223).
- Add argument transformer for msetnx to support Map (#218).
- Fix
msettransformer not supporting keyPrefix (#217).
- [Cluster] Select a random node when the target node is closed.
- [Cluster]
maxRedirectionsalso works forCLUSTERDOWN.
- [Cluster] Fix failover queue not being processed. Shahar Mor.
- [Cluster] Add queue support for failover and CLUSTERDOWN handling. Shahar Mor.
- Emits "error" when connection is down for
scanStream(#199).
- [Sentinel] Emits "error" when all sentinels are unreachable (#200).
- Emits "select" event when the database changed.
- [Cluster] Supports scanStream (#175).
- Update debug module to 2.2.0
- Update bluebird module to 2.9.34
- [Cluster] Support redis schema url.
- [Cluster] Support specifying password for each node.
- Add an option for setting connection name. cgiovanacci.
- Switch to the previous db before re-subscribing channels.
- Listen to the "secureConnect" event when connect via TLS. Jeffrey Jen.
- Improve parser performance.
- Emits "authError" event when the password is wrong(#164).
- Fixed wrong debug output when using sentinels. Colm Hally
- Discard slave if flagged with s_down or o_down. mtlima
- Support TLS.
- Support reconnecting on the specified error.
- Add keepAlive option(defaults to
true). - Fix compatible issues of Buffer with Node.js 4.0.
- Fix errors when sending command to a failed cluster(#56).
- Fix for allNodes array containing nodes not serving the specified slot. henstock
- Restore the previous state before resending the unfulfilled commands. Jay Merrifield
- Fix empty pipeline not resolving as empty array. Philip Kannegaard Hayes
- Handle watch-exec rollback correctly(#199). Andrew Newdigate
- Fix not running callback in pipeline custom command(#117). Philip Kannegaard Hayes
- Fixes status debug message in case of Unix socket path(#114). Thalis Kalfigkopoulos
- Re-subscribe previous channels after reconnection(#110).
- Fix
Redis.Commandnot being exported correctly(#100).
- Add a streaming interface to
SCANcommands. - Support GEO commands.
- Fix the order of received commands(#91).
- Allow omitting callback in
exec.
- Add
send_commandmethod for compatibility(#90).
- Fix connection error emitting before listening to
errorevent(#80).
- Fix
pmessagegetsundefinedin cluster mode(#88). Kris Linquist
- Fix subscriptions lost after reconnection(#85).
- Silent error when redis server has cluster support disabled(#82).
- Fix storing wrong redis host internally.
- Fix masterNodes not being removed correctly.
- Fix sometimes monitor leads command queue error.
- Fix
enableReadyCheckis alwaysfalsein monitor mode(#77).
- Fix getting NaN db index(#74).
- Uses double ended queue instead of Array for better performance.
- Resolves a bug with cluster where a subscribe is sent to a disconnected node(#63). Ari Aosved.
- Adds ReadOnly mode for Cluster mode(#69). Nakul Ganesh.
- Adds
Redis.print(#71). Frank Murphy.
- Continue monitoring after reconnection(#52).
- Support pub/sub in Cluster mode(#54).
- Auto-reconnect when none of startup nodes is ready(#56).
- Support Node.js 0.10.16
- Fix unfulfilled commands being sent to the wrong db(#42).
- Fix possible memory leak warning of Cluster.
- Stop reconnecting when disconnected manually.
- Add missing Promise definition in node 0.10.x.
- Fix possible memory leak warning.
- The constructor of
pipeline/multiaccepts a batch of commands.
- Support pipeline redirection in Cluster mode.
Redis#connectreturns a promise.
- Fix showFriendlyErrorStack not working in pipeline.
- Fix errors when sending commands after connection being closed.
- Try a random node when the target slot isn't served by the cluster.
- Remove
refreshAfterFailsoption. - Try random node when refresh slots.
- Fix errors when
numberOfKeysis0.
- Add
retryDelayOnClusterDownoption to handle CLUSTERDOWN error. - Fix
multicommands sometimes doesn't return a promise.
- Fix
sendCommandsometimes doesn't return a promise.
- Add
autoResendUnfulfilledCommandsoption.
- Support get built-in commands.
- Fix buffer supporting in pipeline. @AVVS.
- Fix error of sending command to wrong node when slot is 0.
- Support Transaction and pipelining in cluster mode.
- Support cluster auto reconnection.
- Add
maxRedirectionsoption to Cluster. - Remove
roleRetryDelayoption in favor ofsentinelRetryStrategy. - Improve compatibility with node_redis.
- More stable sentinel connection.
- Support SORT, ZUNIONSTORE and ZINTERSTORE in Cluster.
- Support for defining custom commands in Cluster.
- Use native array instead of fastqueue for better performance.
- Add
showFriendlyErrorStackoption for outputing friendly error stack.
- Improve performance for calculating slots.
- Support single node commands in cluster mode.
- Add promise supports in Cluster.
- Add
autoResubscribeoption to prevent auto re-subscribe. - Add
Redis#endfor compatibility. - Add
Redis.createClient(wasRedis#createClient).
- Support setting connect timeout.