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, Final, HasCode, HasCommand, HasConfig, PIDCache, RESP3, Retriable 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)
NoScriptError = 
Class.new(CommandError)
ReadOnlyError = 
Class.new(ConnectionError)
MasterDownError = 
Class.new(ConnectionError)
VERSION = 
"0.26.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.



247
248
249
250
251
252
253
 
# File 'lib/redis_client.rb', line 247

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

Class Method Details

.config(**kwargs) ⇒ Object 



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

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 



232
233
234
235
236
237
238
 
# File 'lib/redis_client.rb', line 232

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

.now ⇒ Object 



49
50
51
 
# File 'lib/redis_client.rb', line 49

def now
  Process.clock_gettime(Process::CLOCK_MONOTONIC)
end

.now_ms ⇒ Object 



53
54
55
 
# File 'lib/redis_client.rb', line 53

def now_ms
  Process.clock_gettime(Process::CLOCK_MONOTONIC, :float_millisecond)
end

.register(middleware) ⇒ Object 



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

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 



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

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

Instance Method Details

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



395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/redis_client.rb', line 395

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 



415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/redis_client.rb', line 415

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 



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

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 



365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/redis_client.rb', line 365

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 



380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/redis_client.rb', line 380

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 



350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/redis_client.rb', line 350

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 



475
476
477
478
 
# File 'lib/redis_client.rb', line 475

def close
  @raw_connection&.close
  self
end

#connected? ⇒ Boolean

Returns:

  • (Boolean) 


471
472
473
 
# File 'lib/redis_client.rb', line 471

def connected?
  @raw_connection&.revalidate
end

#db ⇒ Object 



272
273
274
 
# File 'lib/redis_client.rb', line 272

def db
  config.db
end

#disable_reconnection(&block) ⇒ Object 



480
481
482
 
# File 'lib/redis_client.rb', line 480

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

#host ⇒ Object 



276
277
278
 
# File 'lib/redis_client.rb', line 276

def host
  config.host unless config.path
end

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



453
454
455
456
457
458
459
460
 
# File 'lib/redis_client.rb', line 453

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 



264
265
266
 
# File 'lib/redis_client.rb', line 264

def id
  config.id
end

#inspect ⇒ Object 



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

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

#measure_round_trip_delay ⇒ Object 



327
328
329
330
331
332
333
 
# File 'lib/redis_client.rb', line 327

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 



502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/redis_client.rb', line 502

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 



292
293
294
 
# File 'lib/redis_client.rb', line 292

def password
  config.password
end

#path ⇒ Object 



284
285
286
 
# File 'lib/redis_client.rb', line 284

def path
  config.path
end

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

Yields:

  • (pipeline) 


484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
 
# File 'lib/redis_client.rb', line 484

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 



280
281
282
 
# File 'lib/redis_client.rb', line 280

def port
  config.port unless config.path
end

#pubsub ⇒ Object 



321
322
323
324
325
 
# File 'lib/redis_client.rb', line 321

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

#read_timeout=(timeout) ⇒ Object 



311
312
313
314
 
# File 'lib/redis_client.rb', line 311

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

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



435
436
437
438
439
440
441
442
 
# File 'lib/redis_client.rb', line 435

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 



260
261
262
 
# File 'lib/redis_client.rb', line 260

def server_url
  config.server_url
end

#size ⇒ Object 



296
297
298
 
# File 'lib/redis_client.rb', line 296

def size
  1
end

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



444
445
446
447
448
449
450
451
 
# File 'lib/redis_client.rb', line 444

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 



268
269
270
 
# File 'lib/redis_client.rb', line 268

def timeout
  config.read_timeout
end

#timeout=(timeout) ⇒ Object 



305
306
307
308
309
 
# File 'lib/redis_client.rb', line 305

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

#username ⇒ Object 



288
289
290
 
# File 'lib/redis_client.rb', line 288

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



300
301
302
 
# File 'lib/redis_client.rb', line 300

def with(_options = nil)
  yield self
end

#write_timeout=(timeout) ⇒ Object 



316
317
318
319
 
# File 'lib/redis_client.rb', line 316

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

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



462
463
464
465
466
467
468
469
 
# File 'lib/redis_client.rb', line 462

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