redis 3.3.5 → 4.8.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (147) hide show
  1. checksums.yaml +5 -5
  2. data/CHANGELOG.md +236 -2
  3. data/README.md +169 -89
  4. data/lib/redis/client.rb +176 -108
  5. data/lib/redis/cluster/command.rb +79 -0
  6. data/lib/redis/cluster/command_loader.rb +33 -0
  7. data/lib/redis/cluster/key_slot_converter.rb +72 -0
  8. data/lib/redis/cluster/node.rb +120 -0
  9. data/lib/redis/cluster/node_key.rb +31 -0
  10. data/lib/redis/cluster/node_loader.rb +34 -0
  11. data/lib/redis/cluster/option.rb +100 -0
  12. data/lib/redis/cluster/slot.rb +86 -0
  13. data/lib/redis/cluster/slot_loader.rb +46 -0
  14. data/lib/redis/cluster.rb +315 -0
  15. data/lib/redis/commands/bitmaps.rb +63 -0
  16. data/lib/redis/commands/cluster.rb +45 -0
  17. data/lib/redis/commands/connection.rb +58 -0
  18. data/lib/redis/commands/geo.rb +84 -0
  19. data/lib/redis/commands/hashes.rb +251 -0
  20. data/lib/redis/commands/hyper_log_log.rb +37 -0
  21. data/lib/redis/commands/keys.rb +455 -0
  22. data/lib/redis/commands/lists.rb +290 -0
  23. data/lib/redis/commands/pubsub.rb +72 -0
  24. data/lib/redis/commands/scripting.rb +114 -0
  25. data/lib/redis/commands/server.rb +188 -0
  26. data/lib/redis/commands/sets.rb +223 -0
  27. data/lib/redis/commands/sorted_sets.rb +812 -0
  28. data/lib/redis/commands/streams.rb +382 -0
  29. data/lib/redis/commands/strings.rb +313 -0
  30. data/lib/redis/commands/transactions.rb +139 -0
  31. data/lib/redis/commands.rb +240 -0
  32. data/lib/redis/connection/command_helper.rb +7 -10
  33. data/lib/redis/connection/hiredis.rb +5 -3
  34. data/lib/redis/connection/registry.rb +2 -1
  35. data/lib/redis/connection/ruby.rb +136 -128
  36. data/lib/redis/connection/synchrony.rb +24 -9
  37. data/lib/redis/connection.rb +3 -1
  38. data/lib/redis/distributed.rb +255 -85
  39. data/lib/redis/errors.rb +57 -0
  40. data/lib/redis/hash_ring.rb +30 -73
  41. data/lib/redis/pipeline.rb +178 -13
  42. data/lib/redis/subscribe.rb +11 -12
  43. data/lib/redis/version.rb +3 -1
  44. data/lib/redis.rb +174 -2661
  45. metadata +66 -202
  46. data/.gitignore +0 -16
  47. data/.travis/Gemfile +0 -11
  48. data/.travis.yml +0 -89
  49. data/.yardopts +0 -3
  50. data/Gemfile +0 -4
  51. data/Rakefile +0 -87
  52. data/benchmarking/logging.rb +0 -71
  53. data/benchmarking/pipeline.rb +0 -51
  54. data/benchmarking/speed.rb +0 -21
  55. data/benchmarking/suite.rb +0 -24
  56. data/benchmarking/worker.rb +0 -71
  57. data/examples/basic.rb +0 -15
  58. data/examples/consistency.rb +0 -114
  59. data/examples/dist_redis.rb +0 -43
  60. data/examples/incr-decr.rb +0 -17
  61. data/examples/list.rb +0 -26
  62. data/examples/pubsub.rb +0 -37
  63. data/examples/sentinel/sentinel.conf +0 -9
  64. data/examples/sentinel/start +0 -49
  65. data/examples/sentinel.rb +0 -41
  66. data/examples/sets.rb +0 -36
  67. data/examples/unicorn/config.ru +0 -3
  68. data/examples/unicorn/unicorn.rb +0 -20
  69. data/redis.gemspec +0 -44
  70. data/test/bitpos_test.rb +0 -69
  71. data/test/blocking_commands_test.rb +0 -42
  72. data/test/client_test.rb +0 -59
  73. data/test/command_map_test.rb +0 -30
  74. data/test/commands_on_hashes_test.rb +0 -21
  75. data/test/commands_on_hyper_log_log_test.rb +0 -21
  76. data/test/commands_on_lists_test.rb +0 -20
  77. data/test/commands_on_sets_test.rb +0 -77
  78. data/test/commands_on_sorted_sets_test.rb +0 -137
  79. data/test/commands_on_strings_test.rb +0 -101
  80. data/test/commands_on_value_types_test.rb +0 -133
  81. data/test/connection_handling_test.rb +0 -277
  82. data/test/connection_test.rb +0 -57
  83. data/test/db/.gitkeep +0 -0
  84. data/test/distributed_blocking_commands_test.rb +0 -46
  85. data/test/distributed_commands_on_hashes_test.rb +0 -10
  86. data/test/distributed_commands_on_hyper_log_log_test.rb +0 -33
  87. data/test/distributed_commands_on_lists_test.rb +0 -22
  88. data/test/distributed_commands_on_sets_test.rb +0 -83
  89. data/test/distributed_commands_on_sorted_sets_test.rb +0 -18
  90. data/test/distributed_commands_on_strings_test.rb +0 -59
  91. data/test/distributed_commands_on_value_types_test.rb +0 -95
  92. data/test/distributed_commands_requiring_clustering_test.rb +0 -164
  93. data/test/distributed_connection_handling_test.rb +0 -23
  94. data/test/distributed_internals_test.rb +0 -79
  95. data/test/distributed_key_tags_test.rb +0 -52
  96. data/test/distributed_persistence_control_commands_test.rb +0 -26
  97. data/test/distributed_publish_subscribe_test.rb +0 -92
  98. data/test/distributed_remote_server_control_commands_test.rb +0 -66
  99. data/test/distributed_scripting_test.rb +0 -102
  100. data/test/distributed_sorting_test.rb +0 -20
  101. data/test/distributed_test.rb +0 -58
  102. data/test/distributed_transactions_test.rb +0 -32
  103. data/test/encoding_test.rb +0 -18
  104. data/test/error_replies_test.rb +0 -59
  105. data/test/fork_safety_test.rb +0 -65
  106. data/test/helper.rb +0 -232
  107. data/test/helper_test.rb +0 -24
  108. data/test/internals_test.rb +0 -417
  109. data/test/lint/blocking_commands.rb +0 -150
  110. data/test/lint/hashes.rb +0 -162
  111. data/test/lint/hyper_log_log.rb +0 -60
  112. data/test/lint/lists.rb +0 -143
  113. data/test/lint/sets.rb +0 -140
  114. data/test/lint/sorted_sets.rb +0 -316
  115. data/test/lint/strings.rb +0 -260
  116. data/test/lint/value_types.rb +0 -122
  117. data/test/persistence_control_commands_test.rb +0 -26
  118. data/test/pipelining_commands_test.rb +0 -242
  119. data/test/publish_subscribe_test.rb +0 -282
  120. data/test/remote_server_control_commands_test.rb +0 -118
  121. data/test/scanning_test.rb +0 -413
  122. data/test/scripting_test.rb +0 -78
  123. data/test/sentinel_command_test.rb +0 -80
  124. data/test/sentinel_test.rb +0 -255
  125. data/test/sorting_test.rb +0 -59
  126. data/test/ssl_test.rb +0 -73
  127. data/test/support/connection/hiredis.rb +0 -1
  128. data/test/support/connection/ruby.rb +0 -1
  129. data/test/support/connection/synchrony.rb +0 -17
  130. data/test/support/redis_mock.rb +0 -130
  131. data/test/support/ssl/gen_certs.sh +0 -31
  132. data/test/support/ssl/trusted-ca.crt +0 -25
  133. data/test/support/ssl/trusted-ca.key +0 -27
  134. data/test/support/ssl/trusted-cert.crt +0 -81
  135. data/test/support/ssl/trusted-cert.key +0 -28
  136. data/test/support/ssl/untrusted-ca.crt +0 -26
  137. data/test/support/ssl/untrusted-ca.key +0 -27
  138. data/test/support/ssl/untrusted-cert.crt +0 -82
  139. data/test/support/ssl/untrusted-cert.key +0 -28
  140. data/test/support/wire/synchrony.rb +0 -24
  141. data/test/support/wire/thread.rb +0 -5
  142. data/test/synchrony_driver.rb +0 -88
  143. data/test/test.conf.erb +0 -9
  144. data/test/thread_safety_test.rb +0 -62
  145. data/test/transactions_test.rb +0 -264
  146. data/test/unknown_commands_test.rb +0 -14
  147. data/test/url_param_test.rb +0 -138
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 729f56810aa501065e2fc203050363713c80ee37
4
- data.tar.gz: e7e13fb75618f794a2c742d73d6c8a72699d5e92
2
+ SHA256:
3
+ metadata.gz: b18788ff80698e8f79fb103e7419d9ba74fb0b6a5eb55c672422cd76abff985c
4
+ data.tar.gz: 1eed18a57039c677c894564ceaa1cf6bc9c0535be51501d078b09d75617a9d89
5
5
  SHA512:
6
- metadata.gz: f87e76c751760b7f1feb7c859ea373c41ebf805c104c27e85177cb20a60d42b11c50db2d5a916fb7bfc78b82b13141770a851568aea922ccc1970f4e30ba1dea
7
- data.tar.gz: ac4cb236c9c9897d73ead9421e161cf1c7aac2a3c1f77c088b5c52c324cddccda6ab749441093cbcc94ea812e70232f9f9ac1c160a96fd1fbd46d87586d1d7fb
6
+ metadata.gz: 5f2f7ce595d431f548c126a63c5ce697cc9e596e9b0eaa00f1e0186ae3853e73922c6e130b989ba9e026aec32f766a774433fdd1cff216420e837837db90659b
7
+ data.tar.gz: 02fb8debb0d11f7b9d04f7616093535426f0ee5a0994992fcf3187ab00aa890dcd2fb248f14da49837508a3ccbb5756be208fc5d3b8dcd18ec6aaf0fb1bb1193
data/CHANGELOG.md CHANGED
@@ -1,8 +1,242 @@
1
+ # Unreleased
2
+
3
+ # 4.8.1
4
+
5
+ * Automatically reconnect after fork regardless of `reconnect_attempts`
6
+
7
+ # 4.8.0
8
+
9
+ * Introduce `sadd?` and `srem?` as boolean returning versions of `sadd` and `srem`.
10
+ * Deprecate `sadd` and `srem` returning a boolean when called with a single argument.
11
+ To enable the redis 5.0 behavior you can set `Redis.sadd_returns_boolean = false`.
12
+ * Deprecate passing `timeout` as a positional argument in blocking commands (`brpop`, `blop`, etc).
13
+
14
+ # 4.7.1
15
+
16
+ * Gracefully handle OpenSSL 3.0 EOF Errors (`OpenSSL::SSL::SSLError: SSL_read: unexpected eof while reading`). See #1106
17
+ This happens frequently on heroku-22.
18
+
19
+ # 4.7.0
20
+
21
+ * Support single endpoint architecture with SSL/TLS in cluster mode. See #1086.
22
+ * `zrem` and `zadd` act as noop when provided an empty list of keys. See #1097.
23
+ * Support IPv6 URLs.
24
+ * Add `Redis#with` for better compatibility with `connection_pool` usage.
25
+ * Fix the block form of `multi` called inside `pipelined`. Previously the `MUTLI/EXEC` wouldn't be sent. See #1073.
26
+
27
+ # 4.6.0
28
+
29
+ * Deprecate `Redis.current`.
30
+ * Deprecate calling commands on `Redis` inside `Redis#pipelined`. See #1059.
31
+ ```ruby
32
+ redis.pipelined do
33
+ redis.get("key")
34
+ end
35
+ ```
36
+
37
+ should be replaced by:
38
+
39
+ ```ruby
40
+ redis.pipelined do |pipeline|
41
+ pipeline.get("key")
42
+ end
43
+ ```
44
+ * Deprecate calling commands on `Redis` inside `Redis#multi`. See #1059.
45
+ ```ruby
46
+ redis.multi do
47
+ redis.get("key")
48
+ end
49
+ ```
50
+
51
+ should be replaced by:
52
+
53
+ ```ruby
54
+ redis.multi do |transaction|
55
+ transaction.get("key")
56
+ end
57
+ ```
58
+ * Deprecate `Redis#queue` and `Redis#commit`. See #1059.
59
+
60
+ * Fix `zpopmax` and `zpopmin` when called inside a pipeline. See #1055.
61
+ * `Redis#synchronize` is now private like it should always have been.
62
+
63
+ * Add `Redis.silence_deprecations=` to turn off deprecation warnings.
64
+ If you don't wish to see warnings yet, you can set `Redis.silence_deprecations = true`.
65
+ It is however heavily recommended to fix them instead when possible.
66
+ * Add `Redis.raise_deprecations=` to turn deprecation warnings into errors.
67
+ This makes it easier to identitify the source of deprecated APIs usage.
68
+ It is recommended to set `Redis.raise_deprecations = true` in development and test environments.
69
+ * Add new options to ZRANGE. See #1053.
70
+ * Add ZRANGESTORE command. See #1053.
71
+ * Add SCAN support for `Redis::Cluster`. See #1049.
72
+ * Add COPY command. See #1053. See #1048.
73
+ * Add ZDIFFSTORE command. See #1046.
74
+ * Add ZDIFF command. See #1044.
75
+ * Add ZUNION command. See #1042.
76
+ * Add HRANDFIELD command. See #1040.
77
+
78
+ # 4.5.1
79
+
80
+ * 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,
81
+ 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.
82
+ This behavior is deprecated and will be removed in Redis 4.6.0. Fix #1038.
83
+
84
+ # 4.5.0
85
+
86
+ * Handle parts of the command using incompatible encodings. See #1037.
87
+ * Add GET option to SET command. See #1036.
88
+ * Add ZRANDMEMBER command. See #1035.
89
+ * Add LMOVE/BLMOVE commands. See #1034.
90
+ * Add ZMSCORE command. See #1032.
91
+ * Add LT/GT options to ZADD. See #1033.
92
+ * Add SMISMEMBER command. See #1031.
93
+ * Add EXAT/PXAT options to SET. See #1028.
94
+ * Add GETDEL/GETEX commands. See #1024.
95
+ * `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`.
96
+ * Fix Redis < 6 detection during connect. See #1025.
97
+ * Fix fetching command details in Redis cluster when the first node is unhealthy. See #1026.
98
+
99
+ # 4.4.0
100
+
101
+ * Redis cluster: fix cross-slot validation in pipelines. Fix ##1019.
102
+ * Add support for `XAUTOCLAIM`. See #1018.
103
+ * Properly issue `READONLY` when reconnecting to replicas. Fix #1017.
104
+ * Make `del` a noop if passed an empty list of keys. See #998.
105
+ * Add support for `ZINTER`. See #995.
106
+
107
+ # 4.3.1
108
+
109
+ * Fix password authentication against redis server 5 and older.
110
+
111
+ # 4.3.0
112
+
113
+ * Add the TYPE argument to scan and scan_each. See #985.
114
+ * Support AUTH command for ACL. See #967.
115
+
116
+ # 4.2.5
117
+
118
+ * Optimize the ruby connector write buffering. See #964.
119
+
120
+ # 4.2.4
121
+
122
+ * Fix bytesize calculations in the ruby connector, and work on a copy of the buffer. Fix #961, #962.
123
+
124
+ # 4.2.3
125
+
126
+ * Use io/wait instead of IO.select in the ruby connector. See #960.
127
+ * Use exception free non blocking IOs in the ruby connector. See #926.
128
+ * Prevent corruption of the client when an interrupt happen during inside a pipeline block. See #945.
129
+
130
+ # 4.2.2
131
+
132
+ * Fix `WATCH` support for `Redis::Distributed`. See #941.
133
+ * Fix handling of empty stream responses. See #905, #929.
134
+
135
+ # 4.2.1
136
+
137
+ * Fix `exists?` returning an actual boolean when called with multiple keys. See #918.
138
+ * Setting `Redis.exists_returns_integer = false` disables warning message about new behaviour. See #920.
139
+
140
+ # 4.2.0
141
+
142
+ * Convert commands to accept keyword arguments rather than option hashes. This both help catching typos, and reduce needless allocations.
143
+ * Deprecate the synchrony driver. It will be removed in 5.0 and hopefully maintained as a separate gem. See #915.
144
+ * Make `Redis#exists` variadic, will return an Integer if called with multiple keys.
145
+ * Add `Redis#exists?` to get a Boolean if any of the keys exists.
146
+ * `Redis#exists` when called with a single key will warn that future versions will return an Integer.
147
+ Set `Redis.exists_returns_integer = true` to opt-in to the new behavior.
148
+ * Support `keepttl` ooption in `set`. See #913.
149
+ * Optimized initialization of Redis::Cluster. See #912.
150
+ * Accept sentinel options even with string key. See #599.
151
+ * Verify TLS connections by default. See #900.
152
+ * Make `Redis#hset` variadic. It now returns an integer, not a boolean. See #910.
153
+
154
+ # 4.1.4
155
+
156
+ * Alias `Redis#disconnect` as `#close`. See #901.
157
+ * Handle clusters with multiple slot ranges. See #894.
158
+ * Fix password authentication to a redis cluster. See #889.
159
+ * Handle recursive MOVED responses. See #882.
160
+ * Increase buffer size in the ruby connector. See #880.
161
+ * Fix thread safety of `Redis.queue`. See #878.
162
+ * Deprecate `Redis::Future#==` as it's likely to be a mistake. See #876.
163
+ * Support `KEEPTTL` option for SET command. See #913.
164
+
165
+ # 4.1.3
166
+
167
+ * Fix the client hanging forever when connecting with SSL to a non-SSL server. See #835.
168
+
169
+ # 4.1.2
170
+
171
+ * Fix several authentication problems with sentinel. See #850 and #856.
172
+ * Explicitly drop Ruby 2.2 support.
173
+
174
+
175
+ # 4.1.1
176
+
177
+ * Fix error handling in multi blocks. See #754.
178
+ * Fix geoadd to accept arrays like georadius and georadiusbymember. See #841.
179
+ * Fix georadius command failing when long == lat. See #841.
180
+ * Fix timeout error in xread block: 0. See #837.
181
+ * Fix incompatibility issue with redis-objects. See #834.
182
+ * Properly handle Errno::EADDRNOTAVAIL on connect.
183
+ * Fix password authentication to sentinel instances. See #813.
184
+
185
+ # 4.1.0
186
+
187
+ * Add Redis Cluster support. See #716.
188
+ * Add streams support. See #799 and #811.
189
+ * Add ZPOP* support. See #812.
190
+ * Fix issues with integer-like objects as BPOP timeout
191
+
192
+ # 4.0.3
193
+
194
+ * Fix raising command error for first command in pipeline. See #788.
195
+ * Fix the gemspec to stop exposing a `build` executable. See #785.
196
+ * Add `:reconnect_delay` and `:reconnect_delay_max` options. See #778.
197
+
198
+ # 4.0.2
199
+
200
+ * Added `Redis#unlink`. See #766.
201
+
202
+ * `Redis.new` now accept a custom connector via `:connector`. See #591.
203
+
204
+ * `Redis#multi` no longer perform empty transactions. See #747.
205
+
206
+ * `Redis#hdel` now accepts hash keys as multiple arguments like `#del`. See #755.
207
+
208
+ * Allow to skip SSL verification. See #745.
209
+
210
+ * Add Geo commands: `geoadd`, `geohash`, `georadius`, `georadiusbymember`, `geopos`, `geodist`. See #730.
211
+
212
+ # 4.0.1
213
+
214
+ * `Redis::Distributed` now supports `mget` and `mapped_mget`. See #687.
215
+
216
+ * `Redis::Distributed` now supports `sscan` and `sscan_each`. See #572.
217
+
218
+ * `Redis#connection` returns a hash with connection information.
219
+ You shouldn't need to call `Redis#_client`, ever.
220
+
221
+ * `Redis#flushdb` and `Redis#flushall` now support the `:async` option. See #706.
222
+
223
+
224
+ # 4.0
225
+
226
+ * Removed `Redis.connect`. Use `Redis.new`.
227
+
228
+ * Removed `Redis#[]` and `Redis#[]=` aliases.
229
+
230
+ * Added support for `CLIENT` commands. The lower-level client can be
231
+ accessed via `Redis#_client`.
232
+
233
+ * Dropped official support for Ruby < 2.2.2.
234
+
1
235
  # 3.3.5
2
236
 
3
237
  * Fixed Ruby 1.8 compatibility after backporting `Redis#connection`. See #719.
4
238
 
5
- # 3.3.4
239
+ # 3.3.4 (yanked)
6
240
 
7
241
  * `Redis#connection` returns a hash with connection information.
8
242
  You shouldn't need to call `Redis#_client`, ever.
@@ -13,7 +247,7 @@
13
247
 
14
248
  # 3.3.2
15
249
 
16
- * Added support for SPOP with COUNT. See #628.
250
+ * Added support for `SPOP` with COUNT. See #628.
17
251
 
18
252
  * Fixed connection glitches when using SSL. See #644.
19
253
 
data/README.md CHANGED
@@ -1,46 +1,18 @@
1
- # redis-rb [![Build Status][travis-image]][travis-link] [![Inline docs][inchpages-image]][inchpages-link]
1
+ # redis-rb [![Build Status][gh-actions-image]][gh-actions-link] [![Inline docs][inchpages-image]][inchpages-link]
2
2
 
3
- [travis-image]: https://secure.travis-ci.org/redis/redis-rb.png?branch=master
4
- [travis-link]: http://travis-ci.org/redis/redis-rb
5
- [travis-home]: http://travis-ci.org/
6
- [inchpages-image]: http://inch-ci.org/github/redis/redis-rb.png
7
- [inchpages-link]: http://inch-ci.org/github/redis/redis-rb
3
+ A Ruby client that tries to match [Redis][redis-home]' API one-to-one, while still
4
+ providing an idiomatic interface.
8
5
 
9
- A Ruby client library for [Redis][redis-home].
10
-
11
- [redis-home]: http://redis.io
12
-
13
- A Ruby client that tries to match Redis' API one-to-one, while still
14
- providing an idiomatic interface. It features thread-safety, client-side
15
- sharding, pipelining, and an obsession for performance.
16
-
17
- ## Upgrading from 2.x to 3.0
18
-
19
- Please refer to the [CHANGELOG][changelog-3.0.0] for a summary of the
20
- most important changes, as well as a full list of changes.
21
-
22
- [changelog-3.0.0]: https://github.com/redis/redis-rb/blob/master/CHANGELOG.md#300
6
+ See [RubyDoc.info][rubydoc] for the API docs of the latest published gem.
23
7
 
24
8
  ## Getting started
25
9
 
26
- To install **redis-rb**, run the following command:
27
-
28
- ```
29
- gem install redis
30
- ```
31
-
32
- Or if you are using **bundler**, add
10
+ Install with:
33
11
 
34
12
  ```
35
- gem 'redis', '~>3.2'
13
+ $ gem install redis
36
14
  ```
37
15
 
38
- to your `Gemfile`, and run `bundle install`
39
-
40
- As of version 2.0 this client only targets Redis version 2.0 and higher.
41
- You can use an older version of this client if you need to interface
42
- with a Redis instance older than 2.0, but this is no longer supported.
43
-
44
16
  You can connect to Redis by instantiating the `Redis` class:
45
17
 
46
18
  ```ruby
@@ -54,16 +26,17 @@ listening on `localhost`, port 6379. If you need to connect to a remote
54
26
  server or a different port, try:
55
27
 
56
28
  ```ruby
57
- redis = Redis.new(:host => "10.0.1.1", :port => 6380, :db => 15)
29
+ redis = Redis.new(host: "10.0.1.1", port: 6380, db: 15)
58
30
  ```
59
31
 
60
32
  You can also specify connection options as a [`redis://` URL][redis-url]:
61
33
 
62
34
  ```ruby
63
- redis = Redis.new(:url => "redis://:p4ssw0rd@10.0.1.1:6380/15")
35
+ redis = Redis.new(url: "redis://:p4ssw0rd@10.0.1.1:6380/15")
64
36
  ```
65
37
 
66
- [redis-url]: http://www.iana.org/assignments/uri-schemes/prov/redis
38
+ The client expects passwords with special chracters to be URL-encoded (i.e.
39
+ `CGI.escape(password)`).
67
40
 
68
41
  By default, the client will try to read the `REDIS_URL` environment variable
69
42
  and use that as URL to connect to. The above statement is therefore equivalent
@@ -72,13 +45,19 @@ to setting this environment variable and calling `Redis.new` without arguments.
72
45
  To connect to Redis listening on a Unix socket, try:
73
46
 
74
47
  ```ruby
75
- redis = Redis.new(:path => "/tmp/redis.sock")
48
+ redis = Redis.new(path: "/tmp/redis.sock")
76
49
  ```
77
50
 
78
51
  To connect to a password protected Redis instance, use:
79
52
 
80
53
  ```ruby
81
- redis = Redis.new(:password => "mysecret")
54
+ redis = Redis.new(password: "mysecret")
55
+ ```
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')
82
61
  ```
83
62
 
84
63
  The Redis class exports methods that are named identical to the commands
@@ -86,8 +65,6 @@ they execute. The arguments these methods accept are often identical to
86
65
  the arguments specified on the [Redis website][redis-commands]. For
87
66
  instance, the `SET` and `GET` commands can be called like this:
88
67
 
89
- [redis-commands]: http://redis.io/commands
90
-
91
68
  ```ruby
92
69
  redis.set("mykey", "hello world")
93
70
  # => "OK"
@@ -96,24 +73,22 @@ redis.get("mykey")
96
73
  # => "hello world"
97
74
  ```
98
75
 
99
- All commands, their arguments and return values are documented, and
100
- available on [rdoc.info][rdoc].
101
-
102
- [rdoc]: http://rdoc.info/github/redis/redis-rb/
76
+ All commands, their arguments, and return values are documented and
77
+ available on [RubyDoc.info][rubydoc].
103
78
 
104
79
  ## Sentinel support
105
80
 
106
- The client is able to perform automatic failovers by using [Redis
81
+ The client is able to perform automatic failover by using [Redis
107
82
  Sentinel](http://redis.io/topics/sentinel). Make sure to run Redis 2.8+
108
83
  if you want to use this feature.
109
84
 
110
85
  To connect using Sentinel, use:
111
86
 
112
87
  ```ruby
113
- SENTINELS = [{:host => "127.0.0.1", :port => 26380},
114
- {:host => "127.0.0.1", :port => 26381}]
88
+ SENTINELS = [{ host: "127.0.0.1", port: 26380 },
89
+ { host: "127.0.0.1", port: 26381 }]
115
90
 
116
- redis = Redis.new(:url => "redis://mymaster", :sentinels => SENTINELS, :role => :master)
91
+ redis = Redis.new(url: "redis://mymaster", sentinels: SENTINELS, role: :master)
117
92
  ```
118
93
 
119
94
  * The master name identifies a group of Redis instances composed of a master
@@ -130,10 +105,75 @@ but a few so that if one is down the client will try the next one. The client
130
105
  is able to remember the last Sentinel that was able to reply correctly and will
131
106
  use it for the next requests.
132
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
+
158
+ ## Cluster mode with SSL/TLS
159
+ Since Redis can return FQDN of nodes in reply to client since `7.*` with CLUSTER commands, we can use cluster feature with SSL/TLS connection like this:
160
+
161
+ ```ruby
162
+ Redis.new(cluster: %w[rediss://foo.example.com:6379])
163
+ ```
164
+
165
+ On the other hand, in Redis versions prior to `6.*`, you can specify options like the following if cluster mode is enabled and client has to connect to nodes via single endpoint with SSL/TLS.
166
+
167
+ ```ruby
168
+ Redis.new(cluster: %w[rediss://foo-endpoint.example.com:6379], fixed_hostname: 'foo-endpoint.example.com')
169
+ ```
170
+
171
+ In case of the above architecture, if you don't pass the `fixed_hostname` option to the client and servers return IP addresses of nodes, the client may fail to verify certificates.
172
+
133
173
  ## Storing objects
134
174
 
135
- Redis only stores strings as values. If you want to store an object, you
136
- can use a serialization mechanism such as JSON:
175
+ Redis "string" types can be used to store serialized Ruby objects, for
176
+ example with JSON:
137
177
 
138
178
  ```ruby
139
179
  require "json"
@@ -159,9 +199,9 @@ commands to Redis and gathers their replies. These replies are returned
159
199
  by the `#pipelined` method.
160
200
 
161
201
  ```ruby
162
- redis.pipelined do
163
- redis.set "foo", "bar"
164
- redis.incr "baz"
202
+ redis.pipelined do |pipeline|
203
+ pipeline.set "foo", "bar"
204
+ pipeline.incr "baz"
165
205
  end
166
206
  # => ["OK", 1]
167
207
  ```
@@ -175,9 +215,9 @@ the regular pipeline, the replies to the commands are returned by the
175
215
  `#multi` method.
176
216
 
177
217
  ```ruby
178
- redis.multi do
179
- redis.set "foo", "bar"
180
- redis.incr "baz"
218
+ redis.multi do |transaction|
219
+ transaction.set "foo", "bar"
220
+ transaction.incr "baz"
181
221
  end
182
222
  # => ["OK", 1]
183
223
  ```
@@ -185,15 +225,15 @@ end
185
225
  ### Futures
186
226
 
187
227
  Replies to commands in a pipeline can be accessed via the *futures* they
188
- emit (since redis-rb 3.0). All calls inside a pipeline block return a
228
+ emit (since redis-rb 3.0). All calls on the pipeline object return a
189
229
  `Future` object, which responds to the `#value` method. When the
190
230
  pipeline has successfully executed, all futures are assigned their
191
231
  respective replies and can be used.
192
232
 
193
233
  ```ruby
194
- redis.pipelined do
195
- @set = redis.set "foo", "bar"
196
- @incr = redis.incr "baz"
234
+ redis.pipelined do |pipeline|
235
+ @set = pipeline.set "foo", "bar"
236
+ @incr = pipeline.incr "baz"
197
237
  end
198
238
 
199
239
  @set.value
@@ -211,7 +251,7 @@ it can't connect to the server a `Redis::CannotConnectError` error will be raise
211
251
  ```ruby
212
252
  begin
213
253
  redis.ping
214
- rescue Exception => e
254
+ rescue StandardError => e
215
255
  e.inspect
216
256
  # => #<Redis::CannotConnectError: Timed out connecting to Redis on 10.0.1.1:6380>
217
257
 
@@ -246,6 +286,7 @@ All timeout values are specified in seconds.
246
286
  When using pub/sub, you can subscribe to a channel using a timeout as well:
247
287
 
248
288
  ```ruby
289
+ redis = Redis.new(reconnect_attempts: 0)
249
290
  redis.subscribe_with_timeout(5, "news") do |on|
250
291
  on.message do |channel, message|
251
292
  # ...
@@ -255,6 +296,51 @@ end
255
296
 
256
297
  If no message is received after 5 seconds, the client will unsubscribe.
257
298
 
299
+ ## Reconnections
300
+
301
+ The client allows you to configure how many `reconnect_attempts` it should
302
+ complete before declaring a connection as failed. Furthermore, you may want
303
+ to control the maximum duration between reconnection attempts with
304
+ `reconnect_delay` and `reconnect_delay_max`.
305
+
306
+ ```ruby
307
+ Redis.new(
308
+ :reconnect_attempts => 10,
309
+ :reconnect_delay => 1.5,
310
+ :reconnect_delay_max => 10.0,
311
+ )
312
+ ```
313
+
314
+ The delay values are specified in seconds. With the above configuration, the
315
+ client would attempt 10 reconnections, exponentially increasing the duration
316
+ between each attempt but it never waits longer than `reconnect_delay_max`.
317
+
318
+ This is the retry algorithm:
319
+
320
+ ```ruby
321
+ attempt_wait_time = [(reconnect_delay * 2**(attempt-1)), reconnect_delay_max].min
322
+ ```
323
+
324
+ **By default**, this gem will only **retry a connection once** and then fail, but with the
325
+ above configuration the reconnection attempt would look like this:
326
+
327
+ #|Attempt wait time|Total wait time
328
+ :-:|:-:|:-:
329
+ 1|1.5s|1.5s
330
+ 2|3.0s|4.5s
331
+ 3|6.0s|10.5s
332
+ 4|10.0s|20.5s
333
+ 5|10.0s|30.5s
334
+ 6|10.0s|40.5s
335
+ 7|10.0s|50.5s
336
+ 8|10.0s|60.5s
337
+ 9|10.0s|70.5s
338
+ 10|10.0s|80.5s
339
+
340
+ So if the reconnection attempt #10 succeeds 70 seconds have elapsed trying
341
+ to reconnect, this is likely fine in long-running background processes, but if
342
+ you use Redis to drive your website you might want to have a lower
343
+ `reconnect_delay_max` or have less `reconnect_attempts`.
258
344
 
259
345
  ## SSL/TLS Support
260
346
 
@@ -262,7 +348,7 @@ This library supports natively terminating client side SSL/TLS connections
262
348
  when talking to Redis via a server-side proxy such as [stunnel], [hitch],
263
349
  or [ghostunnel].
264
350
 
265
- To enable SSL support, pass the `:ssl => :true` option when configuring the
351
+ To enable SSL support, pass the `:ssl => true` option when configuring the
266
352
  Redis client, or pass in `:url => "rediss://..."` (like HTTPS for Redis).
267
353
  You will also need to pass in an `:ssl_params => { ... }` hash used to
268
354
  configure the `OpenSSL::SSL::SSLContext` object used for the connection:
@@ -374,37 +460,31 @@ redis = Redis.new(:driver => :synchrony)
374
460
 
375
461
  ## Testing
376
462
 
377
- This library is tested using [Travis][travis-home], where it is tested
378
- against the following interpreters and drivers:
463
+ This library is tested against recent Ruby and Redis versions.
464
+ Check [Github Actions][gh-actions-link] for the exact versions supported.
465
+
466
+ ## See Also
379
467
 
380
- * MRI 1.8.7 (drivers: ruby, hiredis)
381
- * MRI 1.9.3 (drivers: ruby, hiredis, synchrony)
382
- * MRI 2.0 (drivers: ruby, hiredis, synchrony)
383
- * MRI 2.1 (drivers: ruby, hiredis, synchrony)
384
- * MRI 2.2 (drivers: ruby, hiredis, synchrony)
385
- * MRI 2.3 (drivers: ruby, hiredis, synchrony)
386
- * JRuby 1.7 (1.8 mode) (drivers: ruby)
387
- * JRuby 1.7 (1.9 mode) (drivers: ruby)
468
+ - [async-redis](https://github.com/socketry/async-redis) — An [async](https://github.com/socketry/async) compatible Redis client.
388
469
 
389
470
  ## Contributors
390
471
 
391
- (ordered chronologically with more than 5 commits, see `git shortlog -sn` for
392
- all contributors)
393
-
394
- * Ezra Zygmuntowicz
395
- * Taylor Weibley
396
- * Matthew Clark
397
- * Brian McKinney
398
- * Luca Guidi
399
- * Salvatore Sanfilippo
400
- * Chris Wanstrath
401
- * Damian Janowski
402
- * Michel Martens
403
- * Nick Quaranto
404
- * Pieter Noordhuis
405
- * Ilya Grigorik
472
+ Several people contributed to redis-rb, but we would like to especially
473
+ mention Ezra Zygmuntowicz. Ezra introduced the Ruby community to many
474
+ new cool technologies, like Redis. He wrote the first version of this
475
+ client and evangelized Redis in Rubyland. Thank you, Ezra.
406
476
 
407
477
  ## Contributing
408
478
 
409
479
  [Fork the project](https://github.com/redis/redis-rb) and send pull
410
- requests. You can also ask for help at `#redis-rb` on Freenode.
480
+ requests.
481
+
482
+
483
+ [inchpages-image]: https://inch-ci.org/github/redis/redis-rb.svg
484
+ [inchpages-link]: https://inch-ci.org/github/redis/redis-rb
485
+ [redis-commands]: https://redis.io/commands
486
+ [redis-home]: https://redis.io
487
+ [redis-url]: http://www.iana.org/assignments/uri-schemes/prov/redis
488
+ [gh-actions-image]: https://github.com/redis/redis-rb/workflows/Test/badge.svg
489
+ [gh-actions-link]: https://github.com/redis/redis-rb/actions
490
+ [rubydoc]: http://www.rubydoc.info/gems/redis