Class: OnlineMigrations::ConstantLockRetrier

Inherits:
LockRetrier
  • Object
show all
Defined in:
lib/online_migrations/lock_retrier.rb

Overview

‘LockRetrier` implementation that has a constant delay between tries and lock timeout for each try

Examples:

# This will attempt 5 retries with 2 seconds between each unsuccessful try
# and 50ms set as lock timeout for each try:
config.retrier = OnlineMigrations::ConstantLockRetrier.new(attempts: 5, delay: 2.seconds, lock_timeout: 0.05.seconds)

Instance Method Summary collapse

Methods inherited from LockRetrier

#with_lock_retries

Constructor Details

#initialize(attempts:, delay:, lock_timeout: nil) ⇒ ConstantLockRetrier

Create a new ConstantLockRetrier instance

Parameters:

  • attempts (Integer) —

    Maximum number of attempts

  • delay (Numeric) —

    Sleep time after unsuccessful lock attempt (in seconds)

  • lock_timeout (Numeric, nil) (defaults to: nil) —

    Database lock timeout value (in seconds)



152
153
154
155
156
157
 
# File 'lib/online_migrations/lock_retrier.rb', line 152

def initialize(attempts:, delay:, lock_timeout: nil)
  super()
  @attempts = attempts
  @delay = delay
  @lock_timeout = lock_timeout
end

Instance Method Details

#attempts(_command = nil, _arguments = []) ⇒ Integer

LockRetrier API implementation

Returns:

  • (Integer) —

    Number of retrying attempts

See Also:



164
165
166
 
# File 'lib/online_migrations/lock_retrier.rb', line 164

def attempts(_command = nil, _arguments = [])
  @attempts
end

#delay(_attempt, _command = nil, _arguments = []) ⇒ Numeric

LockRetrier API implementation

Returns:

  • (Numeric) —

    Sleep time after unsuccessful lock attempt (in seconds)

See Also:



182
183
184
 
# File 'lib/online_migrations/lock_retrier.rb', line 182

def delay(_attempt, _command = nil, _arguments = [])
  @delay
end

#lock_timeout(_attempt, _command = nil, _arguments = []) ⇒ Numeric

LockRetrier API implementation

Returns:

  • (Numeric) —

    Database lock timeout value (in seconds)

See Also:



173
174
175
 
# File 'lib/online_migrations/lock_retrier.rb', line 173

def lock_timeout(_attempt, _command = nil, _arguments = [])
  @lock_timeout
end