-
Notifications
You must be signed in to change notification settings - Fork 1k
/
redis.rb
294 lines (257 loc) · 8.53 KB
/
redis.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
# frozen_string_literal: true
require "monitor"
require "redis/errors"
require "redis/commands"
class Redis
BASE_PATH = __dir__
@exists_returns_integer = true
Deprecated = Class.new(StandardError)
class << self
attr_reader :exists_returns_integer
attr_accessor :silence_deprecations, :raise_deprecations
def exists_returns_integer=(value)
unless value
deprecate!(
"`Redis#exists(key)` will return an Integer by default in redis-rb 4.3. The option to explicitly " \
"disable this behaviour via `Redis.exists_returns_integer` will be removed in 5.0. You should use " \
"`exists?` instead."
)
end
@exists_returns_integer = value
end
def deprecate!(message)
unless silence_deprecations
if raise_deprecations
raise Deprecated, message
else
::Kernel.warn(message)
end
end
end
def current
deprecate!("`Redis.current` is deprecated and will be removed in 5.0. (called from: #{caller(1, 1).first})")
@current ||= Redis.new
end
def current=(redis)
deprecate!("`Redis.current=` is deprecated and will be removed in 5.0. (called from: #{caller(1, 1).first})")
@current = redis
end
end
include Commands
# Create a new client instance
#
# @param [Hash] options
# @option options [String] :url (value of the environment variable REDIS_URL) a Redis URL, for a TCP connection:
# `redis://:[password]@[hostname]:[port]/[db]` (password, port and database are optional), for a unix socket
# connection: `unix://[path to Redis socket]`. This overrides all other options.
# @option options [String] :host ("127.0.0.1") server hostname
# @option options [Integer] :port (6379) server port
# @option options [String] :path path to server socket (overrides host and port)
# @option options [Float] :timeout (5.0) timeout in seconds
# @option options [Float] :connect_timeout (same as timeout) timeout for initial connect in seconds
# @option options [String] :username Username to authenticate against server
# @option options [String] :password Password to authenticate against server
# @option options [Integer] :db (0) Database to select after initial connect
# @option options [Symbol] :driver Driver to use, currently supported: `:ruby`, `:hiredis`, `:synchrony`
# @option options [String] :id ID for the client connection, assigns name to current connection by sending
# `CLIENT SETNAME`
# @option options [Hash, Integer] :tcp_keepalive Keepalive values, if Integer `intvl` and `probe` are calculated
# based on the value, if Hash `time`, `intvl` and `probes` can be specified as a Integer
# @option options [Integer] :reconnect_attempts Number of attempts trying to connect
# @option options [Boolean] :inherit_socket (false) Whether to use socket in forked process or not
# @option options [Array] :sentinels List of sentinels to contact
# @option options [Symbol] :role (:master) Role to fetch via Sentinel, either `:master` or `:slave`
# @option options [Array<String, Hash{Symbol => String, Integer}>] :cluster List of cluster nodes to contact
# @option options [Boolean] :replica Whether to use readonly replica nodes in Redis Cluster or not
# @option options [Class] :connector Class of custom connector
#
# @return [Redis] a new client instance
def initialize(options = {})
@options = options.dup
@cluster_mode = options.key?(:cluster)
client = @cluster_mode ? Cluster : Client
@original_client = @client = client.new(options)
@queue = Hash.new { |h, k| h[k] = [] }
@monitor = Monitor.new
end
# Run code with the client reconnecting
def with_reconnect(val = true, &blk)
synchronize do |client|
client.with_reconnect(val, &blk)
end
end
# Run code without the client reconnecting
def without_reconnect(&blk)
with_reconnect(false, &blk)
end
# Test whether or not the client is connected
def connected?
@original_client.connected?
end
# Disconnect the client as quickly and silently as possible.
def close
@original_client.disconnect
end
alias disconnect! close
# @deprecated Queues a command for pipelining.
#
# Commands in the queue are executed with the Redis#commit method.
#
# See http://redis.io/topics/pipelining for more details.
#
def queue(*command)
::Redis.deprecate!(
"Redis#queue is deprecated and will be removed in Redis 5.0.0. Use Redis#pipelined instead." \
"(called from: #{caller(1, 1).first})"
)
synchronize do
@queue[Thread.current.object_id] << command
end
end
# @deprecated Sends all commands in the queue.
#
# See http://redis.io/topics/pipelining for more details.
#
def commit
::Redis.deprecate!(
"Redis#commit is deprecated and will be removed in Redis 5.0.0. Use Redis#pipelined instead. " \
"(called from: #{Kernel.caller(1, 1).first})"
)
synchronize do |client|
begin
pipeline = Pipeline.new(client)
@queue[Thread.current.object_id].each do |command|
pipeline.call(command)
end
client.call_pipelined(pipeline)
ensure
@queue.delete(Thread.current.object_id)
end
end
end
def _client
@client
end
def pipelined(&block)
deprecation_displayed = false
if block&.arity == 0
Pipeline.deprecation_warning("pipelined", Kernel.caller_locations(1, 5))
deprecation_displayed = true
end
synchronize do |prior_client|
begin
pipeline = Pipeline.new(prior_client)
@client = deprecation_displayed ? pipeline : DeprecatedPipeline.new(pipeline)
pipelined_connection = PipelinedConnection.new(pipeline)
yield pipelined_connection
prior_client.call_pipeline(pipeline)
ensure
@client = prior_client
end
end
end
# Mark the start of a transaction block.
#
# Passing a block is optional.
#
# @example With a block
# redis.multi do |multi|
# multi.set("key", "value")
# multi.incr("counter")
# end # => ["OK", 6]
#
# @example Without a block
# redis.multi
# # => "OK"
# redis.set("key", "value")
# # => "QUEUED"
# redis.incr("counter")
# # => "QUEUED"
# redis.exec
# # => ["OK", 6]
#
# @yield [multi] the commands that are called inside this block are cached
# and written to the server upon returning from it
# @yieldparam [Redis] multi `self`
#
# @return [String, Array<...>]
# - when a block is not given, `OK`
# - when a block is given, an array with replies
#
# @see #watch
# @see #unwatch
def multi(&block)
if block_given?
deprecation_displayed = false
if block&.arity == 0
Pipeline.deprecation_warning("multi", Kernel.caller_locations(1, 5))
deprecation_displayed = true
end
synchronize do |prior_client|
begin
pipeline = Pipeline::Multi.new(prior_client)
@client = deprecation_displayed ? pipeline : DeprecatedMulti.new(pipeline)
pipelined_connection = PipelinedConnection.new(pipeline)
yield pipelined_connection
prior_client.call_pipeline(pipeline)
ensure
@client = prior_client
end
end
else
send_command([:multi])
end
end
def id
@original_client.id
end
def inspect
"#<Redis client v#{Redis::VERSION} for #{id}>"
end
def dup
self.class.new(@options)
end
def connection
return @original_client.connection_info if @cluster_mode
{
host: @original_client.host,
port: @original_client.port,
db: @original_client.db,
id: @original_client.id,
location: @original_client.location
}
end
private
def synchronize
@monitor.synchronize { yield(@client) }
end
def send_command(command, &block)
@monitor.synchronize do
@client.call(command, &block)
end
end
def send_blocking_command(command, timeout, &block)
@monitor.synchronize do
@client.call_with_timeout(command, timeout, &block)
end
end
def _subscription(method, timeout, channels, block)
return @client.call([method] + channels) if subscribed?
begin
original, @client = @client, SubscribedClient.new(@client)
if timeout > 0
@client.send(method, timeout, *channels, &block)
else
@client.send(method, *channels, &block)
end
ensure
@client = original
end
end
end
require "redis/version"
require "redis/connection"
require "redis/client"
require "redis/cluster"
require "redis/pipeline"
require "redis/subscribe"