Class: RedisClient

Inherits:
Object
  • Object
show all
Includes:
Common
Defined in:
lib/redis_client.rb,
lib/redis_client/config.rb,
lib/redis_client/pooled.rb,
lib/redis_client/version.rb,
lib/redis_client/decorator.rb,
lib/redis_client/pid_cache.rb,
lib/redis_client/url_config.rb,
lib/redis_client/middlewares.rb,
lib/redis_client/circuit_breaker.rb,
lib/redis_client/command_builder.rb,
lib/redis_client/ruby_connection.rb,
lib/redis_client/sentinel_config.rb,
lib/redis_client/connection_mixin.rb,
lib/redis_client/ruby_connection/resp3.rb,
lib/redis_client/ruby_connection/buffered_io.rb

Defined Under Namespace

Modules: CommandBuilder, Common, ConnectionMixin, Decorator, HasCommand, HasConfig, PIDCache, RESP3 Classes: BasicMiddleware, CircuitBreaker, CommandError, Config, Error, Middlewares, Multi, Pipeline, Pooled, PubSub, RubyConnection, SentinelConfig, URLConfig

Constant Summary collapse

ProtocolError = 
Class.new(Error)
UnsupportedServer = 
Class.new(Error)
ConnectionError = 
Class.new(Error)
CannotConnectError = 
Class.new(ConnectionError)
FailoverError = 
Class.new(ConnectionError)
TimeoutError = 
Class.new(ConnectionError)
ReadTimeoutError = 
Class.new(TimeoutError)
WriteTimeoutError = 
Class.new(TimeoutError)
CheckoutTimeoutError = 
Class.new(TimeoutError)
AuthenticationError = 
Class.new(CommandError)
PermissionError = 
Class.new(CommandError)
WrongTypeError = 
Class.new(CommandError)
OutOfMemoryError = 
Class.new(CommandError)
ReadOnlyError = 
Class.new(ConnectionError)
MasterDownError = 
Class.new(ConnectionError)
VERSION = 
"0.22.2"

Instance Attribute Summary

Attributes included from Common

#config, #connect_timeout, #read_timeout, #write_timeout

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config) ⇒ RedisClient

Returns a new instance of RedisClient.



188
189
190
191
192
193
 
# File 'lib/redis_client.rb', line 188

def initialize(config, **)
  super
  @middlewares = config.middlewares_stack.new(self)
  @raw_connection = nil
  @disable_reconnection = false
end

Class Method Details

.config(**kwargs) ⇒ Object 



165
166
167
 
# File 'lib/redis_client.rb', line 165

def config(**kwargs)
  Config.new(client_implementation: self, **kwargs)
end

.default_driver ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/redis_client.rb', line 33

def default_driver
  unless @default_driver
    @driver_definitions.each_key do |name|
      if @default_driver = driver(name)
        break
      end
    rescue LoadError
    end
  end
  @default_driver
end

.default_driver=(name) ⇒ Object 



45
46
47
 
# File 'lib/redis_client.rb', line 45

def default_driver=(name)
  @default_driver = driver(name)
end

.driver(name) ⇒ Object 



22
23
24
25
26
27
28
29
30
31
 
# File 'lib/redis_client.rb', line 22

def driver(name)
  return name if name.is_a?(Class)

  name = name.to_sym
  unless @driver_definitions.key?(name)
    raise ArgumentError, "Unknown driver #{name.inspect}, expected one of: `#{@driver_definitions.keys.inspect}`"
  end

  @drivers[name] ||= @driver_definitions[name]&.call
end

.new(arg = nil, **kwargs) ⇒ Object 



173
174
175
176
177
178
179
 
# File 'lib/redis_client.rb', line 173

def new(arg = nil, **kwargs)
  if arg.is_a?(Config::Common)
    super
  else
    super(config(**(arg || {}), **kwargs))
  end
end

.register(middleware) ⇒ Object 



181
182
183
 
# File 'lib/redis_client.rb', line 181

def register(middleware)
  Middlewares.include(middleware)
end

.register_driver(name, &block) ⇒ Object 



18
19
20
 
# File 'lib/redis_client.rb', line 18

def register_driver(name, &block)
  @driver_definitions[name] = block
end

.sentinel(**kwargs) ⇒ Object 



169
170
171
 
# File 'lib/redis_client.rb', line 169

def sentinel(**kwargs)
  SentinelConfig.new(client_implementation: self, **kwargs)
end

Instance Method Details

#blocking_call(timeout, *command, **kwargs) ⇒ Object 



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/redis_client.rb', line 335

def blocking_call(timeout, *command, **kwargs)
  command = @command_builder.generate(command, kwargs)
  error = nil
  result = ensure_connected do |connection|
    @middlewares.call(command, config) do
      connection.call(command, timeout)
    end
  rescue ReadTimeoutError => error
    break
  end

  if error
    raise error
  elsif block_given?
    yield result
  else
    result
  end
end

#blocking_call_v(timeout, command) ⇒ Object 



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/redis_client.rb', line 355

def blocking_call_v(timeout, command)
  command = @command_builder.generate(command)
  error = nil
  result = ensure_connected do |connection|
    @middlewares.call(command, config) do
      connection.call(command, timeout)
    end
  rescue ReadTimeoutError => error
    break
  end

  if error
    raise error
  elsif block_given?
    yield result
  else
    result
  end
end

#call(*command, **kwargs) ⇒ Object 



275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/redis_client.rb', line 275

def call(*command, **kwargs)
  command = @command_builder.generate(command, kwargs)
  result = ensure_connected do |connection|
    @middlewares.call(command, config) do
      connection.call(command, nil)
    end
  end

  if block_given?
    yield result
  else
    result
  end
end

#call_once(*command, **kwargs) ⇒ Object 



305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/redis_client.rb', line 305

def call_once(*command, **kwargs)
  command = @command_builder.generate(command, kwargs)
  result = ensure_connected(retryable: false) do |connection|
    @middlewares.call(command, config) do
      connection.call(command, nil)
    end
  end

  if block_given?
    yield result
  else
    result
  end
end

#call_once_v(command) ⇒ Object 



320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/redis_client.rb', line 320

def call_once_v(command)
  command = @command_builder.generate(command)
  result = ensure_connected(retryable: false) do |connection|
    @middlewares.call(command, config) do
      connection.call(command, nil)
    end
  end

  if block_given?
    yield result
  else
    result
  end
end

#call_v(command) ⇒ Object 



290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/redis_client.rb', line 290

def call_v(command)
  command = @command_builder.generate(command)
  result = ensure_connected do |connection|
    @middlewares.call(command, config) do
      connection.call(command, nil)
    end
  end

  if block_given?
    yield result
  else
    result
  end
end

#close ⇒ Object 



415
416
417
418
 
# File 'lib/redis_client.rb', line 415

def close
  @raw_connection&.close
  self
end

#connected? ⇒ Boolean

Returns:

  • (Boolean) 


411
412
413
 
# File 'lib/redis_client.rb', line 411

def connected?
  @raw_connection&.revalidate
end

#db ⇒ Object 



212
213
214
 
# File 'lib/redis_client.rb', line 212

def db
  config.db
end

#disable_reconnection(&block) ⇒ Object 



420
421
422
 
# File 'lib/redis_client.rb', line 420

def disable_reconnection(&block)
  ensure_connected(retryable: false, &block)
end

#host ⇒ Object 



216
217
218
 
# File 'lib/redis_client.rb', line 216

def host
  config.host unless config.path
end

#hscan(key, *args, **kwargs, &block) ⇒ Object 



393
394
395
396
397
398
399
400
 
# File 'lib/redis_client.rb', line 393

def hscan(key, *args, **kwargs, &block)
  unless block_given?
    return to_enum(__callee__, key, *args, **kwargs)
  end

  args = @command_builder.generate(["HSCAN", key, 0] + args, kwargs)
  scan_pairs(2, args, &block)
end

#id ⇒ Object 



204
205
206
 
# File 'lib/redis_client.rb', line 204

def id
  config.id
end

#inspect ⇒ Object 



195
196
197
198
 
# File 'lib/redis_client.rb', line 195

def inspect
  id_string = " id=#{id}" if id
  "#<#{self.class.name} #{config.server_url}#{id_string}>"
end

#measure_round_trip_delay ⇒ Object 



267
268
269
270
271
272
273
 
# File 'lib/redis_client.rb', line 267

def measure_round_trip_delay
  ensure_connected do |connection|
    @middlewares.call(["PING"], config) do
      connection.measure_round_trip_delay
    end
  end
end

#multi(watch: nil, &block) ⇒ Object 



442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/redis_client.rb', line 442

def multi(watch: nil, &block)
  transaction = nil

  results = if watch
    # WATCH is stateful, so we can't reconnect if it's used, the whole transaction
    # has to be redone.
    ensure_connected(retryable: false) do |connection|
      call("WATCH", *watch)
      begin
        if transaction = build_transaction(&block)
          commands = transaction._commands
          results = @middlewares.call_pipelined(commands, config) do
            connection.call_pipelined(commands, nil)
          end.last
        else
          call("UNWATCH")
          []
        end
      rescue
        call("UNWATCH") if connected? && watch
        raise
      end
    end
  else
    transaction = build_transaction(&block)
    if transaction._empty?
      []
    else
      ensure_connected(retryable: transaction._retryable?) do |connection|
        commands = transaction._commands
        @middlewares.call_pipelined(commands, config) do
          connection.call_pipelined(commands, nil)
        end.last
      end
    end
  end

  if transaction
    transaction._coerce!(results)
  else
    results
  end
end

#password ⇒ Object 



232
233
234
 
# File 'lib/redis_client.rb', line 232

def password
  config.password
end

#path ⇒ Object 



224
225
226
 
# File 'lib/redis_client.rb', line 224

def path
  config.path
end

#pipelined(exception: true) {|pipeline| ... } ⇒ Object

Yields:

  • (pipeline) 


424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/redis_client.rb', line 424

def pipelined(exception: true)
  pipeline = Pipeline.new(@command_builder)
  yield pipeline

  if pipeline._size == 0
    []
  else
    results = ensure_connected(retryable: pipeline._retryable?) do |connection|
      commands = pipeline._commands
      @middlewares.call_pipelined(commands, config) do
        connection.call_pipelined(commands, pipeline._timeouts, exception: exception)
      end
    end

    pipeline._coerce!(results)
  end
end

#port ⇒ Object 



220
221
222
 
# File 'lib/redis_client.rb', line 220

def port
  config.port unless config.path
end

#pubsub ⇒ Object 



261
262
263
264
265
 
# File 'lib/redis_client.rb', line 261

def pubsub
  sub = PubSub.new(ensure_connected, @command_builder)
  @raw_connection = nil
  sub
end

#read_timeout=(timeout) ⇒ Object 



251
252
253
254
 
# File 'lib/redis_client.rb', line 251

def read_timeout=(timeout)
  super
  @raw_connection&.read_timeout = timeout
end

#scan(*args, **kwargs, &block) ⇒ Object 



375
376
377
378
379
380
381
382
 
# File 'lib/redis_client.rb', line 375

def scan(*args, **kwargs, &block)
  unless block_given?
    return to_enum(__callee__, *args, **kwargs)
  end

  args = @command_builder.generate(["SCAN", 0] + args, kwargs)
  scan_list(1, args, &block)
end

#server_url ⇒ Object 



200
201
202
 
# File 'lib/redis_client.rb', line 200

def server_url
  config.server_url
end

#size ⇒ Object 



236
237
238
 
# File 'lib/redis_client.rb', line 236

def size
  1
end

#sscan(key, *args, **kwargs, &block) ⇒ Object 



384
385
386
387
388
389
390
391
 
# File 'lib/redis_client.rb', line 384

def sscan(key, *args, **kwargs, &block)
  unless block_given?
    return to_enum(__callee__, key, *args, **kwargs)
  end

  args = @command_builder.generate(["SSCAN", key, 0] + args, kwargs)
  scan_list(2, args, &block)
end

#timeout ⇒ Object 



208
209
210
 
# File 'lib/redis_client.rb', line 208

def timeout
  config.read_timeout
end

#timeout=(timeout) ⇒ Object 



245
246
247
248
249
 
# File 'lib/redis_client.rb', line 245

def timeout=(timeout)
  super
  @raw_connection&.read_timeout = timeout
  @raw_connection&.write_timeout = timeout
end

#username ⇒ Object 



228
229
230
 
# File 'lib/redis_client.rb', line 228

def username
  config.username
end

#with(_options = nil) {|_self| ... } ⇒ Object Also known as: then

Yields:

  • (_self)

Yield Parameters:

  • _self (RedisClient) —

    the object that the method was called on



240
241
242
 
# File 'lib/redis_client.rb', line 240

def with(_options = nil)
  yield self
end

#write_timeout=(timeout) ⇒ Object 



256
257
258
259
 
# File 'lib/redis_client.rb', line 256

def write_timeout=(timeout)
  super
  @raw_connection&.write_timeout = timeout
end

#zscan(key, *args, **kwargs, &block) ⇒ Object 



402
403
404
405
406
407
408
409
 
# File 'lib/redis_client.rb', line 402

def zscan(key, *args, **kwargs, &block)
  unless block_given?
    return to_enum(__callee__, key, *args, **kwargs)
  end

  args = @command_builder.generate(["ZSCAN", key, 0] + args, kwargs)
  scan_pairs(2, args, &block)
end