redis 4.1.0 → 4.5.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/CHANGELOG.md +107 -0
- data/README.md +81 -17
- data/lib/redis/client.rb +137 -82
- data/lib/redis/cluster/command_loader.rb +6 -7
- data/lib/redis/cluster/node.rb +5 -1
- data/lib/redis/cluster/node_key.rb +3 -7
- data/lib/redis/cluster/option.rb +30 -14
- data/lib/redis/cluster/slot.rb +30 -13
- data/lib/redis/cluster/slot_loader.rb +4 -4
- data/lib/redis/cluster.rb +22 -17
- data/lib/redis/connection/command_helper.rb +5 -2
- data/lib/redis/connection/hiredis.rb +4 -3
- data/lib/redis/connection/registry.rb +2 -1
- data/lib/redis/connection/ruby.rb +121 -105
- data/lib/redis/connection/synchrony.rb +9 -4
- data/lib/redis/connection.rb +2 -0
- data/lib/redis/distributed.rb +170 -68
- data/lib/redis/errors.rb +2 -0
- data/lib/redis/hash_ring.rb +15 -14
- data/lib/redis/pipeline.rb +46 -8
- data/lib/redis/subscribe.rb +11 -12
- data/lib/redis/version.rb +3 -1
- data/lib/redis.rb +808 -476
- metadata +15 -25
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 7a7232fef186e6d6a11a90d8dd9aa7c71114f017e0afe9378999a96c9e6b4e05
|
4
|
+
data.tar.gz: 689f176b87909bf61eb60e57d1eb795198162a7e039104c80facf36880964bda
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 22b11dee92e298b46bb94a707156d3dbf9afb83c8e9e8cbf82cf366d582a7c1b7295d7f09a0fec01965245f4800c2482c0559d646f46ff1c6bba6423ab398ba9
|
7
|
+
data.tar.gz: 9a74ba29c8cb3d7634a44c78e30018a048e19cca66c7fad6a226722183f66546bebb370c92ecdf20522bb35ee72a09b2fda64891ff6d94db1702375bd1ba6b46
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,112 @@
|
|
1
1
|
# Unreleased
|
2
2
|
|
3
|
+
# 4.5.1
|
4
|
+
|
5
|
+
* Restore the accidential auth behavior of redis-rb 4.3.0 with a warning. If provided with the `default` user's password, but a wrong username,
|
6
|
+
redis-rb will first try to connect as the provided user, but then will fallback to connect as the `default` user with the provided password.
|
7
|
+
This behavior is deprecated and will be removed in Redis 4.6.0. Fix #1038.
|
8
|
+
|
9
|
+
# 4.5.0
|
10
|
+
|
11
|
+
* Handle parts of the command using incompatible encodings. See #1037.
|
12
|
+
* Add GET option to SET command. See #1036.
|
13
|
+
* Add ZRANDMEMBER command. See #1035.
|
14
|
+
* Add LMOVE/BLMOVE commands. See #1034.
|
15
|
+
* Add ZMSCORE command. See #1032.
|
16
|
+
* Add LT/GT options to ZADD. See #1033.
|
17
|
+
* Add SMISMEMBER command. See #1031.
|
18
|
+
* Add EXAT/PXAT options to SET. See #1028.
|
19
|
+
* Add GETDEL/GETEX commands. See #1024.
|
20
|
+
* `Redis#exists` now returns an Integer by default, as warned since 4.2.0. The old behavior can be restored with `Redis.exists_returns_integer = false`.
|
21
|
+
* Fix Redis < 6 detection during connect. See #1025.
|
22
|
+
* Fix fetching command details in Redis cluster when the first node is unhealthy. See #1026.
|
23
|
+
|
24
|
+
# 4.4.0
|
25
|
+
|
26
|
+
* Redis cluster: fix cross-slot validation in pipelines. Fix ##1019.
|
27
|
+
* Add support for `XAUTOCLAIM`. See #1018.
|
28
|
+
* Properly issue `READONLY` when reconnecting to replicas. Fix #1017.
|
29
|
+
* Make `del` a noop if passed an empty list of keys. See #998.
|
30
|
+
* Add support for `ZINTER`. See #995.
|
31
|
+
|
32
|
+
# 4.3.1
|
33
|
+
|
34
|
+
* Fix password authentication against redis server 5 and older.
|
35
|
+
|
36
|
+
# 4.3.0
|
37
|
+
|
38
|
+
* Add the TYPE argument to scan and scan_each. See #985.
|
39
|
+
* Support AUTH command for ACL. See #967.
|
40
|
+
|
41
|
+
# 4.2.5
|
42
|
+
|
43
|
+
* Optimize the ruby connector write buffering. See #964.
|
44
|
+
|
45
|
+
# 4.2.4
|
46
|
+
|
47
|
+
* Fix bytesize calculations in the ruby connector, and work on a copy of the buffer. Fix #961, #962.
|
48
|
+
|
49
|
+
# 4.2.3
|
50
|
+
|
51
|
+
* Use io/wait instead of IO.select in the ruby connector. See #960.
|
52
|
+
* Use exception free non blocking IOs in the ruby connector. See #926.
|
53
|
+
* Prevent corruption of the client when an interrupt happen during inside a pipeline block. See #945.
|
54
|
+
|
55
|
+
# 4.2.2
|
56
|
+
|
57
|
+
* Fix `WATCH` support for `Redis::Distributed`. See #941.
|
58
|
+
* Fix handling of empty stream responses. See #905, #929.
|
59
|
+
|
60
|
+
# 4.2.1
|
61
|
+
|
62
|
+
* Fix `exists?` returning an actual boolean when called with multiple keys. See #918.
|
63
|
+
* Setting `Redis.exists_returns_integer = false` disables warning message about new behaviour. See #920.
|
64
|
+
|
65
|
+
# 4.2.0
|
66
|
+
|
67
|
+
* Convert commands to accept keyword arguments rather than option hashes. This both help catching typos, and reduce needless allocations.
|
68
|
+
* Deprecate the synchrony driver. It will be removed in 5.0 and hopefully maintained as a separate gem. See #915.
|
69
|
+
* Make `Redis#exists` variadic, will return an Integer if called with multiple keys.
|
70
|
+
* Add `Redis#exists?` to get a Boolean if any of the keys exists.
|
71
|
+
* `Redis#exists` when called with a single key will warn that future versions will return an Integer.
|
72
|
+
Set `Redis.exists_returns_integer = true` to opt-in to the new behavior.
|
73
|
+
* Support `keepttl` ooption in `set`. See #913.
|
74
|
+
* Optimized initialization of Redis::Cluster. See #912.
|
75
|
+
* Accept sentinel options even with string key. See #599.
|
76
|
+
* Verify TLS connections by default. See #900.
|
77
|
+
* Make `Redis#hset` variadic. It now returns an integer, not a boolean. See #910.
|
78
|
+
|
79
|
+
# 4.1.4
|
80
|
+
|
81
|
+
* Alias `Redis#disconnect` as `#close`. See #901.
|
82
|
+
* Handle clusters with multiple slot ranges. See #894.
|
83
|
+
* Fix password authentication to a redis cluster. See #889.
|
84
|
+
* Handle recursive MOVED responses. See #882.
|
85
|
+
* Increase buffer size in the ruby connector. See #880.
|
86
|
+
* Fix thread safety of `Redis.queue`. See #878.
|
87
|
+
* Deprecate `Redis::Future#==` as it's likely to be a mistake. See #876.
|
88
|
+
* Support `KEEPTTL` option for SET command. See #913.
|
89
|
+
|
90
|
+
# 4.1.3
|
91
|
+
|
92
|
+
* Fix the client hanging forever when connecting with SSL to a non-SSL server. See #835.
|
93
|
+
|
94
|
+
# 4.1.2
|
95
|
+
|
96
|
+
* Fix several authentication problems with sentinel. See #850 and #856.
|
97
|
+
* Explicitly drop Ruby 2.2 support.
|
98
|
+
|
99
|
+
|
100
|
+
# 4.1.1
|
101
|
+
|
102
|
+
* Fix error handling in multi blocks. See #754.
|
103
|
+
* Fix geoadd to accept arrays like georadius and georadiusbymember. See #841.
|
104
|
+
* Fix georadius command failing when long == lat. See #841.
|
105
|
+
* Fix timeout error in xread block: 0. See #837.
|
106
|
+
* Fix incompatibility issue with redis-objects. See #834.
|
107
|
+
* Properly handle Errno::EADDRNOTAVAIL on connect.
|
108
|
+
* Fix password authentication to sentinel instances. See #813.
|
109
|
+
|
3
110
|
# 4.1.0
|
4
111
|
|
5
112
|
* Add Redis Cluster support. See #716.
|
data/README.md
CHANGED
@@ -1,8 +1,9 @@
|
|
1
|
-
# redis-rb [![Build Status][
|
1
|
+
# redis-rb [![Build Status][gh-actions-image]][gh-actions-link] [![Inline docs][inchpages-image]][inchpages-link]
|
2
2
|
|
3
3
|
A Ruby client that tries to match [Redis][redis-home]' API one-to-one, while still
|
4
4
|
providing an idiomatic interface.
|
5
5
|
|
6
|
+
See [RubyDoc.info][rubydoc] for the API docs of the latest published gem.
|
6
7
|
|
7
8
|
## Getting started
|
8
9
|
|
@@ -34,6 +35,9 @@ You can also specify connection options as a [`redis://` URL][redis-url]:
|
|
34
35
|
redis = Redis.new(url: "redis://:p4ssw0rd@10.0.1.1:6380/15")
|
35
36
|
```
|
36
37
|
|
38
|
+
The client expects passwords with special chracters to be URL-encoded (i.e.
|
39
|
+
`CGI.escape(password)`).
|
40
|
+
|
37
41
|
By default, the client will try to read the `REDIS_URL` environment variable
|
38
42
|
and use that as URL to connect to. The above statement is therefore equivalent
|
39
43
|
to setting this environment variable and calling `Redis.new` without arguments.
|
@@ -50,6 +54,12 @@ To connect to a password protected Redis instance, use:
|
|
50
54
|
redis = Redis.new(password: "mysecret")
|
51
55
|
```
|
52
56
|
|
57
|
+
To connect a Redis instance using [ACL](https://redis.io/topics/acl), use:
|
58
|
+
|
59
|
+
```ruby
|
60
|
+
redis = Redis.new(username: 'myname', password: 'mysecret')
|
61
|
+
```
|
62
|
+
|
53
63
|
The Redis class exports methods that are named identical to the commands
|
54
64
|
they execute. The arguments these methods accept are often identical to
|
55
65
|
the arguments specified on the [Redis website][redis-commands]. For
|
@@ -95,10 +105,60 @@ but a few so that if one is down the client will try the next one. The client
|
|
95
105
|
is able to remember the last Sentinel that was able to reply correctly and will
|
96
106
|
use it for the next requests.
|
97
107
|
|
108
|
+
If you want to [authenticate](https://redis.io/topics/sentinel#configuring-sentinel-instances-with-authentication) Sentinel itself, you must specify the `password` option per instance.
|
109
|
+
|
110
|
+
```ruby
|
111
|
+
SENTINELS = [{ host: '127.0.0.1', port: 26380, password: 'mysecret' },
|
112
|
+
{ host: '127.0.0.1', port: 26381, password: 'mysecret' }]
|
113
|
+
|
114
|
+
redis = Redis.new(host: 'mymaster', sentinels: SENTINELS, role: :master)
|
115
|
+
```
|
116
|
+
|
117
|
+
## Cluster support
|
118
|
+
|
119
|
+
`redis-rb` supports [clustering](https://redis.io/topics/cluster-spec).
|
120
|
+
|
121
|
+
```ruby
|
122
|
+
# Nodes can be passed to the client as an array of connection URLs.
|
123
|
+
nodes = (7000..7005).map { |port| "redis://127.0.0.1:#{port}" }
|
124
|
+
redis = Redis.new(cluster: nodes)
|
125
|
+
|
126
|
+
# You can also specify the options as a Hash. The options are the same as for a single server connection.
|
127
|
+
(7000..7005).map { |port| { host: '127.0.0.1', port: port } }
|
128
|
+
```
|
129
|
+
|
130
|
+
You can also specify only a subset of the nodes, and the client will discover the missing ones using the [CLUSTER NODES](https://redis.io/commands/cluster-nodes) command.
|
131
|
+
|
132
|
+
```ruby
|
133
|
+
Redis.new(cluster: %w[redis://127.0.0.1:7000])
|
134
|
+
```
|
135
|
+
|
136
|
+
If you want [the connection to be able to read from any replica](https://redis.io/commands/readonly), you must pass the `replica: true`. Note that this connection won't be usable to write keys.
|
137
|
+
|
138
|
+
```ruby
|
139
|
+
Redis.new(cluster: nodes, replica: true)
|
140
|
+
```
|
141
|
+
|
142
|
+
The calling code is responsible for [avoiding cross slot commands](https://redis.io/topics/cluster-spec#keys-distribution-model).
|
143
|
+
|
144
|
+
```ruby
|
145
|
+
redis = Redis.new(cluster: %w[redis://127.0.0.1:7000])
|
146
|
+
|
147
|
+
redis.mget('key1', 'key2')
|
148
|
+
#=> Redis::CommandError (CROSSSLOT Keys in request don't hash to the same slot)
|
149
|
+
|
150
|
+
redis.mget('{key}1', '{key}2')
|
151
|
+
#=> [nil, nil]
|
152
|
+
```
|
153
|
+
|
154
|
+
* The client automatically reconnects after a failover occurred, but the caller is responsible for handling errors while it is happening.
|
155
|
+
* The client support permanent node failures, and will reroute requests to promoted slaves.
|
156
|
+
* The client supports `MOVED` and `ASK` redirections transparently.
|
157
|
+
|
98
158
|
## Storing objects
|
99
159
|
|
100
|
-
Redis
|
101
|
-
|
160
|
+
Redis "string" types can be used to store serialized Ruby objects, for
|
161
|
+
example with JSON:
|
102
162
|
|
103
163
|
```ruby
|
104
164
|
require "json"
|
@@ -211,6 +271,7 @@ All timeout values are specified in seconds.
|
|
211
271
|
When using pub/sub, you can subscribe to a channel using a timeout as well:
|
212
272
|
|
213
273
|
```ruby
|
274
|
+
redis = Redis.new(reconnect_attempts: 0)
|
214
275
|
redis.subscribe_with_timeout(5, "news") do |on|
|
215
276
|
on.message do |channel, message|
|
216
277
|
# ...
|
@@ -272,7 +333,7 @@ This library supports natively terminating client side SSL/TLS connections
|
|
272
333
|
when talking to Redis via a server-side proxy such as [stunnel], [hitch],
|
273
334
|
or [ghostunnel].
|
274
335
|
|
275
|
-
To enable SSL support, pass the `:ssl =>
|
336
|
+
To enable SSL support, pass the `:ssl => true` option when configuring the
|
276
337
|
Redis client, or pass in `:url => "rediss://..."` (like HTTPS for Redis).
|
277
338
|
You will also need to pass in an `:ssl_params => { ... }` hash used to
|
278
339
|
configure the `OpenSSL::SSL::SSLContext` object used for the connection:
|
@@ -385,7 +446,11 @@ redis = Redis.new(:driver => :synchrony)
|
|
385
446
|
## Testing
|
386
447
|
|
387
448
|
This library is tested against recent Ruby and Redis versions.
|
388
|
-
Check [
|
449
|
+
Check [Github Actions][gh-actions-link] for the exact versions supported.
|
450
|
+
|
451
|
+
## See Also
|
452
|
+
|
453
|
+
- [async-redis](https://github.com/socketry/async-redis) — An [async](https://github.com/socketry/async) compatible Redis client.
|
389
454
|
|
390
455
|
## Contributors
|
391
456
|
|
@@ -397,15 +462,14 @@ client and evangelized Redis in Rubyland. Thank you, Ezra.
|
|
397
462
|
## Contributing
|
398
463
|
|
399
464
|
[Fork the project](https://github.com/redis/redis-rb) and send pull
|
400
|
-
requests.
|
401
|
-
|
402
|
-
|
403
|
-
[inchpages-image]:
|
404
|
-
[inchpages-link]:
|
405
|
-
[redis-commands]:
|
406
|
-
[redis-home]:
|
407
|
-
[redis-url]:
|
408
|
-
[
|
409
|
-
[
|
410
|
-
[
|
411
|
-
[rubydoc]: http://www.rubydoc.info/gems/redis
|
465
|
+
requests.
|
466
|
+
|
467
|
+
|
468
|
+
[inchpages-image]: https://inch-ci.org/github/redis/redis-rb.svg
|
469
|
+
[inchpages-link]: https://inch-ci.org/github/redis/redis-rb
|
470
|
+
[redis-commands]: https://redis.io/commands
|
471
|
+
[redis-home]: https://redis.io
|
472
|
+
[redis-url]: http://www.iana.org/assignments/uri-schemes/prov/redis
|
473
|
+
[gh-actions-image]: https://github.com/redis/redis-rb/workflows/Test/badge.svg
|
474
|
+
[gh-actions-link]: https://github.com/redis/redis-rb/actions
|
475
|
+
[rubydoc]: http://www.rubydoc.info/gems/redis
|